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 › Client.GetSegments

Client.GetSegments

Gets a list of all subscriber segments for a client.

Parameters and required information

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

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

ClientID
The ID of the client whose subscriber segments should be returned. See here for more details.

Return Codes

Success

Upon a successful call, this method will return a collection of List objects, each of which consists of the ListID for the parent list and Segment Name for each segment for a client.

Error

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

102: Invalid ClientID
The ClientID 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/Client.GetSegments"

<?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>
    <Client.GetSegments xmlns="http://api.createsend.com/api/">
      <ApiKey>string</ApiKey>
      <ClientID>string</ClientID>
    </Client.GetSegments>
  </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>
    <Client.GetSegmentsResponse xmlns="http://api.createsend.com/api/">
      <Client.GetSegmentsResult>
        <List>
          <ListID>string</ListID>
          <Name>string</Name>
        </List>
        <List>
          <ListID>string</ListID>
          <Name>string</Name>
        </List>
      </Client.GetSegmentsResult>
    </Client.GetSegmentsResponse>
  </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/Campaign.GetSegments?ApiKey=string&ClientID=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"?>
<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>
    <Client.GetSegmentsResponse xmlns="http://api.createsend.com/api/">
      <Client.GetSegmentsResult>
        <List>
          <ListID>string</ListID>
          <Name>string</Name>
        </List>
        <List>
          <ListID>string</ListID>
          <Name>string</Name>
        </List>
      </Client.GetSegmentsResult>
    </Client.GetSegmentsResponse>
  </soap:Body>
</soap:Envelope>

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/Campaign.GetSegments HTTP/1.1
Host: api.createsend.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ApiKey=string&ClientID=string
 
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>
    <Client.GetSegmentsResponse xmlns="http://api.createsend.com/api/">
      <Client.GetSegmentsResult>
        <List>
          <ListID>string</ListID>
          <Name>string</Name>
        </List>
        <List>
          <ListID>string</ListID>
          <Name>string</Name>
        </List>
      </Client.GetSegmentsResult>
    </Client.GetSegmentsResponse>
  </soap:Body>
</soap:Envelope>