Usage
Use CreateDistributionList to add one or more eMarketing Distribution Lists to your Cvent account data. The CreateDistributionList call is analogous to the INSERT statement in SQL.
Basic Steps
- Create an instance of one or more individual Distribution List objects.
- Construct a DistributionList array and populate that array with the Distribution Lists you want to create.
- Optionally, specify the MessageID if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes.
- Call CreateDistributionList, passing in the DistributionList array.
- Process the results in the CreateDistributionListResultArray object to verify whether the transactions have been successfully created.
General Syntax
CreateDistributionListResultArray = cventapi.CreateDistributionList(DistributionListArray)Input
| Name | Type | Description |
|---|---|---|
| DistributionLists | Distribution List Array | Array of DistributionList objects that need to be created. |
Output
| Name | Type | Description |
|---|---|---|
| Id | ID | ID of the distribution list that will be created. |
| ReferenceId | ID | MessageId input. |
| Success | Boolean | Indicates whether the action taken was successful (True) or not (False) for the object instance. |
| Errors | Error Array | If an error occurred when the action was taken, an array of one or more Error objects providing the error code and description. |
Validation Rules
The following validation rules should be applied to the CreateDistributionList call:
| Validation Rule | Description |
|---|---|
| Length | The application will truncate data which exceeds the maximum length of a field. |
| Read-Only | The application will ignore the value in the read-only fields. |
Last updated on