Get contact status by email

The GetContactStatusByEmail method returns the current status (subscribed, deleted and so on - see below for a full list) of a contact.

Guidance Notes

Parameters

username	string	This is the username from your API key. It is in the format of an email address and will look similar to apiuser‑908709770324@apiconnector.com	required
password	string	This is the password from your API key.	required
email	string	The email address of the contact whose status you wish to retrieve	required

Return values

result

Subscribed, UnSubscribed, SoftBounced, HardBounced, ISPComplained, MailBlocked, PendingOptIn, DirectComplaint, SpamTrap, Deleted, SharedSuppression, DomainSuppression, NoMXRecord, NotAllowed or Other

Error responses

ERROR_APIUSAGE_EXCEEDED
ERROR_INVALID_EMAIL
ERROR_INVALID_LOGIN
ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE
ERROR_UNKNOWN

Request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/GetContactStatusByEmail"

Example of use in C# .NET

public void GetContactStatus()
        {
            const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
            const string password = "password";
            // Get an instance to the web reference
            com.apiconnector.API api = new com.apiconnector.API();
            try
            {
                var status = api.GetContactStatusByEmail(username, password, "john@example.com");
                Console.WriteLine(status);
            }
            catch (SoapException ex)  // catch any soap issues/errors from the web service
            {
                Console.WriteLine("Error -> {0}", ex.Message);
            }
        }

Sample request

POST /API.asmx HTTP/1.1
Host: api.dotmailerv4-infiniteloops_staging.dotmailer-internal
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/GetContactStatusByEmail"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetContactStatusByEmail xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <email>string</email>
    </GetContactStatusByEmail>
  </soap:Body>
</soap:Envelope>

Sample response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetContactStatusByEmailResponse xmlns="http://apiconnector.com">
      <GetContactStatusByEmailResult>Subscribed or UnSubscribed or SoftBounced or HardBounced or ISPComplained or MailBlocked or PendingOptIn or DirectComplaint or SpamTrap or Deleted or SharedSuppression or DomainSuppression or NoMXRecord or NotAllowed or Other</GetContactStatusByEmailResult>
    </GetContactStatusByEmailResponse>
  </soap:Body>
</soap:Envelope>

Prebuilt integrations

More about API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates