external help file | Module Name | online version | schema |
---|---|---|---|
ConnectWiseManageAPI-help.xml |
ConnectWiseManageAPI |
2.0.0 |
This will modify a contact by its ID.
Update-CWMCompanyContact [-id] <Int32> [-Operation] <String> [-Path] <String> [-Value] <Object> [-WhatIf]
[-Confirm] [<CommonParameters>]
You can perform one of the PATCH operations on a contact.
PS C:\> Update-CWMCompanyContact -id $Contact.id -Operation add -Path 'title' -Value 'Janitor'
Will add a title to the given contact.
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
What you are doing with the value. replace, add, remove
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: add, replace, remove
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The path to the property that you want to perform the operation on.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The value you want to set the property to.
Type: Object
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
The ID of the contact you want to update.
Type: Int32
Parameter Sets: (All)
Aliases: contactId
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.