Client.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 client with no access to the application.

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 Client.Create method. All of the parameters are required unless otherwise noted. By default a new client has no direct access to the application. Access and billing settings (if needed) must be set by means of a subsequent call to Client.UpdateAccessAndBilling.

ApiKey
Your API application key. See here for more details.

CompanyName
The client company name.

ContactName
The personal name of the principle contact for this client.

EmailAddress
An email address to which this client will be sent application-related emails.

Country
This client’s country. A valid country list is available here or by using the API procedure User.GetCountries.

Timezone
Client timezone for tracking and reporting data. A valid timezone list is available here or by using the API procedure User.GetTimezones.

Return Codes

Success

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

Error

1: Invalid Email
Email address is missing or incorrectly formatted

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

150: Email Taken
Chosen email address is already being used

152: Invalid Timezone
Timezone string is not in the correct format. Call User.GetTimezones for a full list.

154: Empty Company Name
Company name cannot be empty

155: Empty Contact Name
Contact name cannot be empty

157: Invalid Country
Country string is either empty or invalid

172: Client Creation Limit
You can create a maximum of five (5) clients per thirty (30) minutes

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/Client.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>
    <Client.Create xmlns="http://api.createsend.com/api/">
      <ApiKey>string</ApiKey>
      <CompanyName>string</CompanyName>
      <ContactName>string</ContactName>
      <EmailAddress>string</EmailAddress>
      <Country>string</Country>
      <Timezone>string</Timezone>
    </Client.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>
    <Client.CreateResponse xmlns="http://api.createsend.com/api/">
      <Client.CreateResult>string</Client.CreateResult>
    </Client.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/Client.Create?ApiKey=string&CompanyName=string&ContactName=string&EmailAddress=string&Country=string&Timezone=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/Client.Create HTTP/1.1
Host: api.createsend.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ApiKey=string&CompanyName=string&ContactName=string&EmailAddress=string&Country=string&Timezone=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