Overview
Returns the Opt In Status of an email address via an http form post.
Post Url
- 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 | |
| 75 | Yes |
* An error will not result if Max Length is exceeded. Data will be trimmed to this length.
Sample Results
Success Messages
<?xml version="1.0"?>
<results>
<message>Success</message>
<details>
<emailaddress>test@domain.com</emailaddress>
<optinstatus>Opt In</optinstatus>
</details>
</results>
Possible Values for OptInStatus:
Opt In
Opt Out
Unknown
Pending
Bounced
Spam Report
Sample Failure Messages
<?xml version="1.0"?>
<results>
<error>Authentication failed</error>
</results>
<?xml version="1.0"?>
<results>
<error>Email Address Not Found</error>
</results>
