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

Get Started with CME Developer Resources
Fields on Standard Objects
Standard Objects
Associated Objects
Platform Event Objects
REST Reference
Resources
Request Bodies
Additional Fields Input
Bulk Product Details Input
CME Asset Amend Input
Configuration Options Input
Configurator Added Node Input
Configurator Deleted Node Input
Configurator Input
Configurator Options Input
Configurator Preference Input
Configurator Updated Node Input
User Context Input
Context Data Input
Context Input
Execution Settings Input
Filter Criteria Input
Filter Input
Group Ramp Action Input
Manage Links Input
Manage Product Relationship Rules Request Input
Object Graph Input
Object Input Map
Object with Reference Input
Sales Transaction Bulk Operation Filter
Sales Transaction Bulk Operation Input
Sales Transaction Input
Product Data Input
Product Details Input
Product List Input
Related Object Filter Input
User Context Input
Recipient Group Input
Split Recipient Group Input
Response Bodies
Invocable Actions
PDF

Recipient Group Input

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

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