Accessing required keys & 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 api.createsend.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 available.

You are able to access this endpoint using HTTP (http://api.createsend.com/api/api.asmx) although we recommend that you use HTTP Secure (https://api.createsend.com/api/api.asmx) which provides a secure connection between your application and our API.

To reach the WSDL for our API, use api.createsend.com/api/api.asmx?wsdl.

Your API Key

You can find your unique API key by clicking on the "Account Settings" link at the top of your screen.

Subscriber List ID

You can find the API Subscriber List ID by clicking any subscriber list under the "Manage Subscribers" tab, and then by clicking the "edit list name/type" link (Hint: It's the link next to the list name at the top).

Client ID

You can find the API Client ID by clicking the "Client Settings" tab for any of your clients.

{title}

Custom Fields

For any methods requiring the submission of custom field data, the custom field consists of a Key/Value pair. Values can be whatever you'd like, 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].

{title}

To find this info, click the "Manage Subscribers" tab. Select a list, and then click the "Custom fields" link on the right side of your screen.

Custom Fields - Multi-Options (select many)

If your custom field is of type "Multi-Options (select many)" and you want to pass in multiple values for the field, you need to specify a Key/Value pair for each value you want to pass in, ensuring that the key is the same for all values you want to assign to the custom field. This is significantly different to the method of importing from a CSV file, where you would use a double-pipe separator between each alternate value in a multi-option field.

The example below shows only the CustomFields section of the XML in a SOAP request, where a subscriber's "Multi-Options (select many)" type field called "Interests" is to be populated with the values "animals" and "architecture".

<CustomFields>
    <SubscriberCustomField>
        <Key>[Interests]</Key>
        <Value>animals</Value>
    </SubscriberCustomField>
    <SubscriberCustomField>
        <Key>[Interests]</Key>
        <Value>architecture</Value>
    </SubscriberCustomField>
</CustomFields>

API Kits

API Methods