Usage
Use DeleteContact to delete one or more existing contacts in your organization’s data. This process will remove a contact from the address book but it will not remove a contacts association with existing events.
Basic Steps
- Determine the ID of each contact you want to delete. For example, you might call Search to retrieve a set of Contacts IDs you want to delete. If you store the Cvent IDs for your contact records within your database, you can use these IDs to delete the desired contacts.
- Construct a CvObject array and populate it with the IDs of each contact you want to delete.
- 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 DeleteContact, passing in the ID array.
- Process the results in the DeleteContactResultArray object to verify whether the objects have been successfully deleted.
General Syntax
DeleteContactResultArray = cventapi.DeleteContact(CvObjectArray CvObjects)Input
| Name | Type | Description |
|---|---|---|
| CvObjects | CvObject Array | Array of one or more CvObject, which contains Contacts IDs to be deleted, and optionally MessageIds which will be returned as ReferenceIds. |
Output
| Name | Type | Description |
|---|---|---|
| Id | ID | ID of the contact that you attempted to update. If this field contains a value, then the contact was successfully updated. If this field is empty, then the contact was not updated and the Cvent Web service returned error information instead. |
| ReferenceId | ID | The MessageId value in the input CvObject. |
| SourceId | String | Source ID of the contact. If the deleted contact had a Source ID associated with it that Source ID returned. If there was no Source ID associated with the contact record in Cvent the field will be empty. |
| Success | Boolean | Indicates whether the Delete call succeeded (True) or not (False) for this contact. |
| Errors | Error Array | If an error occurred during the Update call, an array of one or more Error objects providing the error code and description. |
Last updated on