Create a free account

API Documentation

Campaign Monitor

Accessing required keys and ID's

To keep your subscriber data safe and ensure you can only access your own account, we've developed a simple authentication system. Each Campaign Monitor account has its own unique API key that must be included in all interactions. In most cases this will be combined with a Subscriber List ID or Client ID, depending on the method being used.

Service Endpoint

The endpoint for each API method call is http://app.campaignmonitor.com/api/api.asmx. You'll see this referred to in the samples in a variety of manners, and you can also visit the URL in your browser to see the list of methods avaialble. To reach the WSDL description, use http://app.campaignmonitor.com/api/api.asmx?wsdl.

Your API Key

You can find your unique API key under Account Details in your Account Settings. The API Key is highlighted in red below.

The API Key

Subscriber List ID

You can find the API Subscriber List ID under List Details on the Subscriber List page under Manage Subscribers. The API List ID is highlighted in red below.

The Subscriber List ID

Client ID

You can find the API Client ID under Client Details on the Manage this Client page under Manage Clients. The API Client ID is highlighted in red below.

The Client ID

Custom Fields

For any methods requiring the submission of custom field data, the custom field consists of a Key/Value pair. The value is simply the value you are submitting, however the key must be whatever you have set as the personalization tag for that custom field, minus the fallback text. So, from the screenshot below, for the custom field Zip Code, it's key would be [ZipCode].

You can find this info under Manage Subscribers, select the list the custom field bleongs to, and select Custom Fields from the navs on the right.

Custom Fields