API


Click here for a complete list of operations.

ListSuppressedContacts

Retrieve a list of suppressed contacts along with the reason for suppression.You may not request more than 1000 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information.

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: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/ListSuppressedContacts"

<?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>
    <ListSuppressedContacts xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <startDate>dateTime</startDate>
      <select>int</select>
      <skip>int</skip>
    </ListSuppressedContacts>
  </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>
    <ListSuppressedContactsResponse xmlns="http://apiconnector.com">
      <ListSuppressedContactsResult>
        <APIContactSuppressionSummary>
          <DateRemoved>dateTime</DateRemoved>
          <SuppressedContact>
            <ID>int</ID>
            <Email>string</Email>
            <AudienceType>Unknown or B2C or B2B or B2M</AudienceType>
            <DataFields xsi:nil="true" />
            <OptInType>Unknown or Single or Double or VerifiedDouble</OptInType>
            <EmailType>PlainText or Html</EmailType>
            <Notes>string</Notes>
          </SuppressedContact>
          <Reason>Subscribed or UnSubscribed or SoftBounced or HardBounced or ISPComplained or MailBlocked or PendingOptIn or DirectComplaint or SpamTrap or Deleted or BlockedLocalPart or SharedSuppression or SharedDomainSuppression or Suppressed or Purchased or KnownComplainer or KnownLitigator or DomainSuppression or NoMXRecord</Reason>
        </APIContactSuppressionSummary>
        <APIContactSuppressionSummary>
          <DateRemoved>dateTime</DateRemoved>
          <SuppressedContact>
            <ID>int</ID>
            <Email>string</Email>
            <AudienceType>Unknown or B2C or B2B or B2M</AudienceType>
            <DataFields xsi:nil="true" />
            <OptInType>Unknown or Single or Double or VerifiedDouble</OptInType>
            <EmailType>PlainText or Html</EmailType>
            <Notes>string</Notes>
          </SuppressedContact>
          <Reason>Subscribed or UnSubscribed or SoftBounced or HardBounced or ISPComplained or MailBlocked or PendingOptIn or DirectComplaint or SpamTrap or Deleted or BlockedLocalPart or SharedSuppression or SharedDomainSuppression or Suppressed or Purchased or KnownComplainer or KnownLitigator or DomainSuppression or NoMXRecord</Reason>
        </APIContactSuppressionSummary>
      </ListSuppressedContactsResult>
    </ListSuppressedContactsResponse>
  </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: apiconnector.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>
    <ListSuppressedContacts xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <startDate>dateTime</startDate>
      <select>int</select>
      <skip>int</skip>
    </ListSuppressedContacts>
  </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>
    <ListSuppressedContactsResponse xmlns="http://apiconnector.com">
      <ListSuppressedContactsResult>
        <APIContactSuppressionSummary>
          <DateRemoved>dateTime</DateRemoved>
          <SuppressedContact>
            <ID>int</ID>
            <Email>string</Email>
            <AudienceType>Unknown or B2C or B2B or B2M</AudienceType>
            <DataFields xsi:nil="true" />
            <OptInType>Unknown or Single or Double or VerifiedDouble</OptInType>
            <EmailType>PlainText or Html</EmailType>
            <Notes>string</Notes>
          </SuppressedContact>
          <Reason>Subscribed or UnSubscribed or SoftBounced or HardBounced or ISPComplained or MailBlocked or PendingOptIn or DirectComplaint or SpamTrap or Deleted or BlockedLocalPart or SharedSuppression or SharedDomainSuppression or Suppressed or Purchased or KnownComplainer or KnownLitigator or DomainSuppression or NoMXRecord</Reason>
        </APIContactSuppressionSummary>
        <APIContactSuppressionSummary>
          <DateRemoved>dateTime</DateRemoved>
          <SuppressedContact>
            <ID>int</ID>
            <Email>string</Email>
            <AudienceType>Unknown or B2C or B2B or B2M</AudienceType>
            <DataFields xsi:nil="true" />
            <OptInType>Unknown or Single or Double or VerifiedDouble</OptInType>
            <EmailType>PlainText or Html</EmailType>
            <Notes>string</Notes>
          </SuppressedContact>
          <Reason>Subscribed or UnSubscribed or SoftBounced or HardBounced or ISPComplained or MailBlocked or PendingOptIn or DirectComplaint or SpamTrap or Deleted or BlockedLocalPart or SharedSuppression or SharedDomainSuppression or Suppressed or Purchased or KnownComplainer or KnownLitigator or DomainSuppression or NoMXRecord</Reason>
        </APIContactSuppressionSummary>
      </ListSuppressedContactsResult>
    </ListSuppressedContactsResponse>
  </soap12:Body>
</soap12:Envelope>