API Documentation

MailBuild

Subscribers.GetUnsubscribed

Gets a list of all subscribers for a list that have unsubscribed since the specified date.

Arguments

The parameters you need to pass in are:

ApiKey (Required): Your API application key. See here for more details.
ListID (Required): The list you want to add the subscriber to. See here for more details.
Date (Required): Subscribers added after the Date value specified will be returned. Must be in the format YYYY-MM-DD HH:MM:SS.

SOAP

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

POST http://yoursitename.createsend.com/api/api.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://api.createsend.com/api/Subscribers.GetUnsubscribed"

<?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>
    <Subscribers.GetUnsubscribed xmlns="http://api.createsend.com/api/">
      <ApiKey>string</ApiKey>
      <ListID>string</ListID>
      <Date>string</Date>
    </Subscribers.GetUnsubscribed>
  </soap:Body>
</soap:Envelope>

Here is the response you will receive.

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8

<?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>
    <Subscribers.GetUnsubscribedResponse xmlns="http://api.createsend.com/api/">
      <Subscribers.GetUnsubscribedResult>
        <Subscriber>
          <EmailAddress>string</EmailAddress>
          <Name>string</Name>
          <Date>string</Date>
          <CustomFields>
            <SubscriberCustomField>
              <Key>string</Key>
              <Value>string</Value>
            </SubscriberCustomField>
            <SubscriberCustomField>
              <Key>string</Key>
              <Value>string</Value>
            </SubscriberCustomField>
          </CustomFields>
        </Subscriber>
      </Subscribers.GetUnsubscribedResult>
    </Subscribers.GetUnsubscribedResponse>
  </soap:Body>
</soap:Envelope>

Error Codes

5: Invalid date: The date value passed in was an invalid date.
100: Invalid API Key: The API key passed was not valid or has expired.
101: Invalid ListID: The ListID value passed in was not valid.