Skip to content

Latest commit

 

History

History
168 lines (130 loc) · 3.2 KB

File metadata and controls

168 lines (130 loc) · 3.2 KB
external help file ConnectWiseManageAPI-help.xml
Module Name ConnectWiseManageAPI
online version https://developer.connectwise.com/Products/Manage/REST#/ContactCommunications/patchCompanyContactsByParentIdCommunicationsById
schema 2.0.0

Update-CWMContactCommunication

SYNOPSIS

Update a contacts communication data.

SYNTAX

Update-CWMContactCommunication [-parentId] <Int32> -id <Int32> [-Operation] <String> [-Path] <String>
 [-Value] <Object> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Used to update the communicationItems property of a contact.

EXAMPLES

EXAMPLE 1

PS C:\> Update-CWMContactCommunication -parentId 123 -Operation replace -Path 'value' -Value 'new@email.com'

Update the value of communication item 123 to the new value.

PARAMETERS

-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

-Operation

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

-Path

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

-Value

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

-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

-parentId

The ID of the contact you want to modify.

Type: Int32
Parameter Sets: (All)
Aliases: contactId

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-id

The ID of the communication item you want to update.

Type: Int32
Parameter Sets: (All)
Aliases: communicationId

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

None

OUTPUTS

System.Object

NOTES

RELATED LINKS