Usage

Use ManageDistributionListMembers to manage Distribution List members based on the provided action.

Determine the IDs of the contacts you want to update. For example, you might call Search to retrieve a set of Contact IDs you want to update. If you store the Cvent IDs for your contact records within your database, you can use these IDs to update the desired contacts.
Construct an ID array and populate it with the IDs of each contact record you want to update
Optionally, specify the MessageId if you want 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 ManageDistributionListMembers, passing the distribution list ID, the action you want to take on the contacts, and the contact group ID.
Note

The “Remove” action removes contacts from the list and does not delete the distribution list itself.
Process the results in the ManageDistributionListMembersResultArray object to verify whether the transactions have been successfully created.

General Syntax

ManageDistributionListMembersResultArray = cventapi.ManageDistributionListMembers(ID, Action, CvObjectArray)

Name	Type	Description
Id	ID	ID of the Distribution List.
Action	Manage DistributionList action	The action that is going to be performed on the contracts. Valid actions Add, Add as Pending, and Remove.
CvObjectArray	CvObject Array	Array of Contact IDs that need to be added or removed from list.

Name	Type	Description
Id	ID	ID of the Distribution List that will be updated.
ReferenceId	String	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.

The following validation rules should be applied to the ManageDistributionListMembers call:

Validation Rule	Description
Actions	Valid actions are Add, Add as Pending, and Remove. For the Add action to succeed, the contact must not already be a member of the specified contact group. For the Add as Pending action to succeed, the contact must not already by a member of the specified contact group. For the Remove action to succeed, the contact must already be a member of the specified contact group.
Uniqueness	Based on ID, only the first instance of a contact in the array will update the contact record. All subsequent instances will return an error message.

Last updated on January 15, 2025