Description
Deletes the specified Contact.
Parameters
Name | Data Type | Required / Optional | Description |
---|---|---|---|
auth-userid | Integer | Required | Authentication Parameter |
api-key | String | Required | Authentication Parameter |
contact-id | Integer | Required | The Contact that you want to delete |
HTTP Method
POST
Example Test URL
https://test.httpapi.com/api/contacts/delete.json?auth-userid=0&api-key=key&contact-id=0
Response
Returns a hash map containing the below details:
-
Contact ID (entityid)
-
Action Type (actiontype)
-
Description of the Contact Deletion Action (actiontypedesc)
-
Action ID of the Contact Deletion Action (eaqid)
-
Contact Deletion Action Status (actionstatus)
-
Description of the Contact Deletion Action Status (actionstatusdesc)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.