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/RECIPIENT_GROUP_ID/recipients

Where RECIPIENT_GROUP_ID is a variable.

Resource Example

1https://YOUR_INSTANCE.salesforce.com/services/data/68.0/connect/comms-sales/recipient-group/{recipientGroupId}/recipients

Where, YOUR_INSTANCE and {recipientGroupId} are variables.

Available Version

64.0

HTTP Methods

PATCH

Request Body for PATCH

JSON Example

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

Properties

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