Usage

Use TransferInvitee to create or find an Invitee record associated for a specific contact and activity combination.

Determine the ID of the activity for which you want to transfer the invitee by calling the Search method.
Determine the ID of the contact you want to transfer. For example, you can call the Search method to retrieve the existing contact’s ID. If the contact does not already exist within your address book, call the CreateContact method. If the contact already exists and you would like to update the contact’s record before transferring the invitee, call the UpdateContact method.
Specify the ID of the TargetedList to associate the contacts (optional). Contacts get added to default TargetedList if none specified.
Construct a CvObject array and populate it with the IDs of each contact you want to transfer.
Optionally, specify the MessageId if you need to track the transfer result of each Contact object. 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.
Make the TransferInvitee call.
Redirect the invitee to the desired target Web link.

General Syntax

TransferInviteeResultArray = cventapi.TransferInvitee (ActivityType ActivityType, ID ActivityId, ID TargetedListId, CvObjectArray CvObjects)

Name	Type	Description
ActivityType	Activity Type	The type of activity for which you want to create an Invitee record, Event, Campaign, or Survey.
ActivityId	ID	The ID of the activity for which you want to create an Invitee record.
TargetedListId	ID	The ID of the targeted list which you want to associate an invitee.
CvObjects	CvObject Array	Array of one or more CvObject, which contains contacts IDs to be transferred, and optionally MessageIds which will be returned as ReferenceIds.

Name	Type	Description
Id	ID	ID of the invitee that you attempted to transfer. If this field contains a value, then the invitee was created or already exists for the given activity contact combination. If this field is empty, then the invitee could not be created or found and the Cvent Web service returned error information instead.
ReferenceId	ID	The MessageId value in the input CvObject.
Success	Boolean	Indicates whether the Create call succeeded (True) or not (False) for this object.
WeblinkDetailArray	Weblink	This is an array of the valid Web links associated with the Invitee. Each Web link is made up of a Target (String) and a URL (string). Provided the transfer call was successful this array will be populated.
Errors	Error Array	If an error occurred during the Create call, an array of one or more Error objects providing the error code and description.

Last updated on January 8, 2025