Account

Gives you access to core account information such as your API key, the available clients in your account and helper procedures when creating a client including available countries, time zones and the current date and time in your account.

Getting your clients

Contains a list of all the clients in your account, including their name and ID.

Request:
GET
http://api.createsend.com/api/v3/clients.{xml|json}
Expected Response: JSON XML 
                    HTTP/1.1 200 OK
                    Content-Type: application/json; charset=utf-8

                    [
                      {
                        "ClientID": "4a397ccaaa55eb4e6aa1221e1e2d7122",
                        "Name": "Client One"
                      },
                      {
                        "ClientID": "a206def0582eec7dae47d937a4109cb2",
                        "Name": "Client Two"
                      }
                    ]
Error Responses:

Please see our response status codes documentation for details of potential error responses for any API request.

Getting your API key

Allows a client or designer to retrieve their API key, given their username, password, and site URL. This is the only API request which requires that you provide your username and password using HTTP basic authentication rather than passing in your API key as the username for basic authentication.

So, instead of providing your API key as the username portion and a dummy password as you would for regular authentication, you'll need to provide the actual username and password you use to login to your account. It is strongly recommended that you use the secure API endpoint for all calls to this method: https://api.createsend.com/api/v3/

Request:
GET
http://api.createsend.com/api/v3/apikey.{xml|json}?siteurl={siteurl}
Route Values:
{siteurl}

The base URL of your CreateSend site. e.g. http://example.createsend.com/.

Expected Response: JSON XML 
                    HTTP/1.1 200 OK
                    Content-Type: application/json; charset=utf-8

                    {
                      "ApiKey": "04f82350a845ey7y87y87y82091015a00"
                    }
Error Responses:

Please see our response status codes documentation for details of potential error responses for any API request.

Getting valid countries

Contains a list of all the valid countries accepted as input when a country is required, typically when creating a client.

Request:
GET
http://api.createsend.com/api/v3/countries.{xml|json}
Expected Response: JSON XML 
                    HTTP/1.1 200 OK
                    Content-Type: application/json; charset=utf-8

                    [
                      "Afghanistan",
                      "Albania",
                      "Algeria",
                      "American Samoa",
                      "etc..."
                    ]
Error Responses:

Please see our response status codes documentation for details of potential error responses for any API request.

Getting valid timezones

Contains a list of all the valid timezones accepted as input when a timezone is required, typically when creating a client.

Request:
GET
http://api.createsend.com/api/v3/timezones.{xml|json}
Expected Response: JSON XML 
                    HTTP/1.1 200 OK
                    Content-Type: application/json; charset=utf-8

                    [
                      "(GMT) Casablanca",
                      "(GMT) Coordinated Universal Time",
                      "(GMT) Dublin, Edinburgh, Lisbon, London",
                      "(GMT) Monrovia, Reykjavik",
                      "etc..."
                    ]
Error Responses:

Please see our response status codes documentation for details of potential error responses for any API request.

Getting current date

Contains the current date and time in your account's timezone. This is useful when, for example, you are syncing your Campaign Monitor lists with an external list, allowing you to accurately determine the time on our server when you carry out the synchronization.

Request:
GET
http://api.createsend.com/api/v3/systemdate.{xml|json}
Expected Response: JSON XML 
                    HTTP/1.1 200 OK
                    Content-Type: application/json; charset=utf-8

                    {
                      "SystemDate": "2010-11-16 14:18:00"
                    }
Error Responses:

Please see our response status codes documentation for details of potential error responses for any API request.