SetOptInStatus

Overview

Set the Opt In Status of an email address via an http form post.

Please be sure to understand our Anti-SPAM Policy and understand that sending unsolicited email with AllClients is strictly prohibited and will result in cancellation of your account.

Email Opt In Status is not tracked per contact, but rather uniquely by the actual email address within the account.

Rules for OPT-IN:  Only email addresses with an Opt In Status of “Unknown” can be Opted In via the API (You cannot overwrite a Spam Report, Opt Out, Bounce, etc.)

Rules for OPT-OUT and BOUNCED: Only email address with an Opt In Status of “Unknown” or “Opt In” can be Opted Out via the API

Rules for SPAM REPORT:    Just like in the main system, a Spam Report cannot be undone, even via the API.   Use cautiously.

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
email 75 Yes
status 1 Yes Values:
1 : Opt In
2 : Opt Out
: Bounce
4 : Spam Report

* 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>Email Address (test@domain.com) is Now Opt In</details>
</results>

<?xml version="1.0"?>
<results>
  <message>Success</message>
  <details>Email Address (test@domain.com) is Now Opt Out</details>
</results>

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> 

<?xml version="1.0"?> 
<results> 
    <error>Unable to Set Opt In Status (Not allowed for current status
    </error> 
</results>