Overview
Delete a contact based on information sent via an http form post.
Post Url
https://www.allclients.com/api/2/DeleteContactByEmail.aspx
- SSL is requred
- White Label CRM Customers: Replace www.allclients.com with your White Label CRM domain name.
Form Fields
Field | Max Length* | Required | Notes |
response_type | No | Default results will be returned in XML.Set this field value to json to return results in JSON format | |
accountid | Yes | Must be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
apikey | Yes | API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
Yes | Specify contact by email address. Multiple contacts will be deleted if they have the same matching email address. |
Sample Results
Success Message
<?xml version="1.0" ?>
<results>
<deletedcontacts>
<deletedcontact>
<id>15622</id>
</deletedcontact>
<deletedcontact>
<id>923623</id>
</deletedcontact>
</deletedcontacts>
<summary>
<deletecount>2</deletecount>
</summary>
</results>
Sample Failure Message
<?xml version="1.0"?>
<results>
<error>Authentication failed</error>
</results