Available from R17.0.0
This method returns the customers that will be communicated through a specific communication plan.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
| communication_plan_identifier (mandatory) | Communication Plan Identifier | The identifier of the communication plan through which the customers returned as a result will be communicated. The allowed communication plan type identifier fields are the following:
| ||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
contact_information_id | String | The ID of the retrieved contact information |
contact_information_name | String | The full name of the retrieved contact information |
Examples
HTTP Method: GET
Request:
Response: