Contacts
This page has been generated from the NinjaOne PowerShell module source. To make changes please edit the appropriate PowerShell source file.
SYNOPSIS
Updates a system contact.
SYNTAX
Set-NinjaOneContact [-id] <Int32> [-contact] <Object> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Updates a system contact via the NinjaOne v2 API.
EXAMPLES
EXAMPLE 1
# FULL REQUEST EXAMPLE (AUTO-GENERATED) - BEGIN
PS> $body = @{
firstName = "string"
lastName = "string"
email = "string"
jobTitle = "string"
organizationId = 0
phone = "string"
}
PS> Set-NinjaOneContact -id 1 -contact $body
# FULL REQUEST EXAMPLE (AUTO-GENERATED) - END
Full request example (auto-generated).
EXAMPLE 2
Set-NinjaOneContact -Id 123 -contact @{ phone = '+3100000000' }
Updates the system contact with Id 123.
PARAMETERS
-id
Contact Id to update.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-contact
Contact patch payload per API schema.
Type: Object
Parameter Sets: (All)
Aliases: body
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
Status code or updated resource per API.
NOTES
RELATED LINKS
https://docs.homotechsual.dev/modules/ninjaone/commandlets/Set/contact