API Documentation

Campaign Monitor

Subscriber.Unsubscribe

Changes the status of an Active Subscriber to an Unsubscribed Subscriber who will no longer receive campaigns sent to that Subscriber List.

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

Samples

While we don't have any samples for this particular method, we do have a number of samples in .NET, PHP, Classic ASP, Flash, Perl and Cold Fusion that can be easily adapted to use this method.

Parameters and required information

Here's a list of all the parameters you'll need to pass to the Subscriber.Unsubscribe method. All of the parameters are required unless otherwise noted.

ApiKey: Your API application key. See here for more details.
ListID: The list you are removing the subscriber from. See here for more details.
Email: The email address of subscriber to be removed.

Return Codes

Success

0: Success: The subscription was successful.

Error

1: Invalid email address: The email value passed in was a valid email address.
100: Invalid API Key: The API key passed was not valid or has expired.
101: Invalid ListID: The ListID value passed in was not valid.
202: Subscriber not in list or has already been removed: There isn't a subscriber in the specified list with the email address passed in.

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: app.campaignmonitor.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://app.campaignmonitor.com/api/Subscriber.Unsubscribe"


<?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>
    <Subscriber.Unsubscribe xmlns="http://app.campaignmonitor.com/api/">
      <ApiKey>string</ApiKey>
      <ListID>int</ListID>

      <Email>string</Email>
    </Subscriber.Unsubscribe>
  </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>
    <Subscriber.UnsubscribeResponse xmlns="http://app.campaignmonitor.com/api/">

      <Subscriber.UnsubscribeResult>
        <Code>int</Code>
        <Message>string</Message>
      </Subscriber.UnsubscribeResult>
    </Subscriber.UnsubscribeResponse>

  </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/Subscriber.Unsubscribe?ApiKey=string&ListID=string&Email=string HTTP/1.1
Host: app.campaignmonitor.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://app.campaignmonitor.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/Subscriber.Unsubscribe HTTP/1.1
Host: app.campaignmonitor.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ApiKey=string&ListID=string&Email=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://app.campaignmonitor.com/api/">
  <Code>int</Code>

  <Message>string</Message>
</Result>