Recipient Group

Update a recipient group by adding or removing recipients who are associated with offers or products that share the same configuration.

Resource

1/connect/comms-sales/recipient-group/{recipientGroupId}/recipients

Example URI

1https://yourInstance.salesforce.com/services/data/67.0/connect/media/applications

Available version

64.0

HTTP methods

PATCH

Request body for PATCH

JSON example

1
2{
3  "recipientsAction": "Add/Remove",
4  "recipientsList": ["recipientId1", "recipientId2"],
5  "additionalParameters": {
6       "key1": "value1"
7  }
8}

Request parameters for PATCH

Parameter Name	Type	Description	Required or Optional	Available Version
`recipientsAction`	String	Recipient action you want to perform, such as adding or removing a recipient from a group.	Required	64.0
`recipientsList`	List <String>	List of recipients that you want to add or removed from a group.	Optional	64.0
`additionalParameters`	Map<String, String>	Parameter to include additional parameter.	Optional	64.0

Response body for PATCH

Updating Recipient Group Output

Communications, Media, Energy and Utilities (CME) Developer Guide

Recipient Group