This is an older version of the Campaign Monitor API. We strongly encourage you to quit livin' in the past and use the shiny new RESTful version with lots of new functionality. You won't regret it.

API › Subscribers.GetActive

Subscribers.GetActive

Gets a list of all active subscribers for a list that have been added since the specified date.

Parameters and required information

Here’s a list of all the parameters you’ll need to pass to the Subscribers.GetActive method. All of the parameters are required unless otherwise noted.

ApiKey
Your API application key. See here for more details.

ListID
The list you want to add the subscriber to. See here for more details.

Date
Subscribers added after the Date value specified will be returned. Must be in the format YYYY-MM-DD HH:MM:SS.

Return Codes

Success

Upon a successful call, this method will return a collection of Subscriber complex types. The individual Subscriber records consist of EmailAddress, Name, Date (YYYY-MM-DD HH:MM:SS), State (in this case, Active) and an array of CustomFields, which in turn consist of Key and Value attributes.

Error

5: Invalid date
The date value passed in was an invalid date.

100: Invalid API Key
The API key pass was not valid or has expired.

101: Invalid ListID
The ListID value passed in was not valid.

SOAP 1.1

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

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

<?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.GetActive xmlns="http://api.createsend.com/api/">
      <ApiKey>string</ApiKey>
      <ListID>string</ListID>
      <Date>string</Date>
    </Subscribers.GetActive>
  </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>
    <Subscribers.GetActiveResponse xmlns="http://api.createsend.com/api/">
      <Subscribers.GetActiveResult>
        <Subscriber>
          <EmailAddress>string</EmailAddress>
          <Name>string</Name>
          <Date>string</Date>
          <State>string</State>
            <SubscriberCustomField>
              <Key>string</Key>
              <Value>string</Value>
            </SubscriberCustomField>
        </Subscriber>
         <Subscriber>
          <EmailAddress>string</EmailAddress>
          <Name>string</Name>
          <Date>string</Date>
          <State>string</State>
            <SubscriberCustomField>
              <Key>string</Key>
              <Value>string</Value>
            </SubscriberCustomField>
        </Subscriber>
      </Subscribers.GetActiveResult>
    </Subscribers.GetActiveResponse>
  </soap:Body>
</soap:Envelope>

HTTP Get

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

GET /api/api.asmx/Subscribers.GetActive?ApiKey=string&ListID=string&Date=string HTTP/1.1
Host: api.createsend.com
 
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfSubscriber xmlns="http://api.createsend.com/api/">
  <Subscriber>
    <EmailAddress>string</EmailAddress>
    <Name>string</Name>
    <Date>string</Date>
    <State>string</State>
    <CustomFields>
      <SubscriberCustomField>
        <Key>string</Key>
        <Value>string</Value>
      </SubscriberCustomField>
      <SubscriberCustomField>
        <Key>string</Key>
        <Value>string</Value>
      </SubscriberCustomField>
    </CustomFields>
  </Subscriber>
  <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>
</ArrayOfSubscriber>

HTTP Post

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

POST /api/api.asmx/Subscribers.GetActive HTTP/1.1
Host: api.createsend.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ApiKey=string&ListID=string&Date=string
 
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfSubscriber xmlns="http://api.createsend.com/api/">
  <Subscriber>
    <EmailAddress>string</EmailAddress>
    <Name>string</Name>
    <Date>string</Date>
    <State>string</State>
    <CustomFields>
      <SubscriberCustomField>
        <Key>string</Key>
        <Value>string</Value>
      </SubscriberCustomField>
      <SubscriberCustomField>
        <Key>string</Key>
        <Value>string</Value>
      </SubscriberCustomField>
    </CustomFields>
  </Subscriber>
  <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>
</ArrayOfSubscriber>