API Web Service

API

Click here for a complete list of operations.

GetContactStatusByEmail

Retrieves a contact status using an email address

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /api.asmx HTTP/1.1
Host: api.dotdigital.com
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>

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 Suppressed or SharedSuppression or DomainSuppression or NoMXRecord or NotAllowed or Other</GetContactStatusByEmailResult>
    </GetContactStatusByEmailResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /api.asmx HTTP/1.1
Host: api.dotdigital.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetContactStatusByEmail xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <email>string</email>
    </GetContactStatusByEmail>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12: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 Suppressed or SharedSuppression or DomainSuppression or NoMXRecord or NotAllowed or Other</GetContactStatusByEmailResult>
    </GetContactStatusByEmailResponse>
  </soap12:Body>
</soap12:Envelope>