List.Create

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.

Creates a brand new subscriber list

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.Create 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 who will owner of the list. See here for more details.

Title
The list title. Must be unique for this client.

UnsubscribePage
The URL to which subscribers will be directed when unsubscribing from the list. If left blank or omitted a generic unsubscribe page is used.

ConfirmOptIn
Either true or false depending on whether the list requires email confirmation or not. Please see the help documentation for more details of what this means.

ConfirmationSuccessPage
Successful email confirmations will be redirected to this URL. Ignored if ConfirmOptIn is false. If left blank or omitted a generic confirmation page is used.

Return Codes

Success

Upon a successful call, this method will return a string containing the ListID of the newly created list.

Error

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

102: Invalid ClientD
The ClientID value passed in was not valid.

250: Duplicate List Title
Cannot create a list with the same title as another

251: List Title Empty
The list title cannot be empty

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.Create"

<?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.Create xmlns="http://api.createsend.com/api/">
      <ApiKey>string</ApiKey>
      <ClientID>string</ClientID>
      <Title>string</Title>
      <UnsubscribePage>string</UnsubscribePage>
      <ConfirmOptIn>boolean</ConfirmOptIn>
      <ConfirmationSuccessPage>string</ConfirmationSuccessPage>
    </List.Create>
  </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.CreateResponse xmlns="http://api.createsend.com/api/">
      <List.CreateResult>string</List.CreateResult>
    </List.CreateResponse>
  </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.Create?ApiKey=string&ClientID=string&Title=string&UnsubscribePage=string&ConfirmOptIn=string&ConfirmationSuccessPage=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"?>
<string xmlns="http://api.createsend.com/api/">string</string>

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

ApiKey=string&ClientID=string&Title=string&UnsubscribePage=string&ConfirmOptIn=string&ConfirmationSuccessPage=string

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

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://api.createsend.com/api/">string</string>

API Documentation