GetOptInStatusList

Overview

Returns the Opt In Status of all email addresses in an account via an http form post. R

Notes

Email Opt In Status is stored in the account, and not tied directly to a contact.   Deleting a contact or changing a contact’s email address will not change the opt in status for the email address.

If an email address is not listed in this API function, then it’s status is “Unknown”

WARNING:  This command can return a large amount of data.   Please plan accordingly.

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

 

Sample Results

Success Messages

<?xml version="1.0"?>
<results>
  <emails>
    <email>
        <address>test@domain.com</address>
        <status>Opt In</status>
    </email>
    <email>
        <address>test2@domain.com</address>
        <status>Bounced</status>
    </email>
  </emails>
</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>