Communications Cloud Sales Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Communications Cloud Sales Resources
REST Reference
Resources
Request Bodies
Recipient Group Input
Split Recipient Group Input
Response Bodies
PDF

Recipient Group Input

Input representation of the recipients required to add or remove them from a recipient group.
JSON example

{
  "recipientsAction": "Add/Remove",
  "recipientsList": ["recipientId1", "recipientId2"],
  "additionalParameters": {
       "key1": "value1"
  }
}
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