List.Delete

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.

Deletes a 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.Delete 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 which is to be deleted. See here for more details.

Return Codes

Success

0: Success
The list was successfully removed

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.

252: List has campaigns
The list indicated by the ListID is attached to one or more draft campaigns

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

<?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.Delete xmlns="http://api.createsend.com/api/">
      <ApiKey>string</ApiKey>
      <ListID>string</ListID>
    </List.Delete>
  </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.DeleteResponse xmlns="http://api.createsend.com/api/">
      <List.DeleteResult>
        <Code>int</Code>
        <Message>string</Message>
      </List.DeleteResult>
    </List.DeleteResponse>
  </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.Delete?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"?>
<Result xmlns="http://api.createsend.com/api/">
  <Code>int</Code>
  <Message>string</Message>
</Result>

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.Delete 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"?>
<Result xmlns="http://api.createsend.com/api/">
  <Code>int</Code>
  <Message>string</Message>
</Result>

API Documentation