Usage
Use DeleteUser to delete one or more existing users from your account.
Basic Steps
- Determine the ID of each user you want to delete. For example, you might call Search to retrieve a set of users IDs you want to delete. If you store the Cvent IDs for your user records within your database, you can use these IDs to delete the desired users.
- Construct a CvObject array and populate it with the IDs of each user 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 DeleteUser, passing in the ID array.
- Process the results in the DeleteUserResultArray object to verify whether the objects have been successfully deleted.
General Syntax
DeleteUserResultArray = cventapi.DeleteUser(CvObjectArray CvObjects)Input
| Name | Type | Description |
|---|---|---|
| Users | CvObject Array | Array of one or more CvObject, which contains user IDs to be deleted, and optionally MessageIds which will be returned as ReferenceIds. |
Output
| Name | Type | Description |
|---|---|---|
| Id | ID | ID of the user that you attempted to update. If this field contains a value, then the contact was successfully updated. If this field is empty, then the user was not updated and the Cvent Web service returned error information instead. |
| ReferenceId | ID | The MessageId value in the input CvObject. |
| Success | Boolean | Indicates whether the Delete call succeeded (True) or not (False) for this user. |
| 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. |