List.GetDetail

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.

Gets a list’s configuration detail

Parameters and required information
Return Codes
SOAP 1.1
HTTP GET
HTTP POST

Parameters and required information

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

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

ListID
The ID of the list whose details will be returned. See here for more details.

Return Codes

Success

A successful call to List.GetDetail will return a ListDetail object, consisting of ListID, Title, UnsubscribePage, ConfirmOptIn, and ConfirmationSuccessPage (all as described in List.Update and List.Create).

Error

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/List.GetDetail"

<?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>
    <List.GetDetail xmlns="http://api.createsend.com/api/">
      <ApiKey>string</ApiKey>
      <ListID>string</ListID>
    </List.GetDetail>
  </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>
    <List.GetDetailResponse xmlns="http://api.createsend.com/api/">
      <List.GetDetailResult>
        <ListID>string</ListID>
        <Title>string</Title>
        <UnsubscribePage>string</UnsubscribePage>
        <ConfirmOptIn>boolean</ConfirmOptIn>
        <ConfirmationSuccessPage>string</ConfirmationSuccessPage>
      </List.GetDetailResult>
    </List.GetDetailResponse>
  </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/List.GetDetail?ApiKey=string&ListID=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"?>
<ListDetail xmlns="http://api.createsend.com/api/">
  <ListID>string</ListID>
  <Title>string</Title>
  <UnsubscribePage>string</UnsubscribePage>
  <ConfirmOptIn>boolean</ConfirmOptIn>
  <ConfirmationSuccessPage>string</ConfirmationSuccessPage>
</ListDetail>

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

ApiKey=string&ListID=string

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

<?xml version="1.0" encoding="utf-8"?>
<ListDetail xmlns="http://api.createsend.com/api/">
  <ListID>string</ListID>
  <Title>string</Title>
  <UnsubscribePage>string</UnsubscribePage>
  <ConfirmOptIn>boolean</ConfirmOptIn>
  <ConfirmationSuccessPage>string</ConfirmationSuccessPage>
</ListDetail>

API Documentation