API Reference

A valid API token must be passed with every request. You can pass the token either as a parameter or as the username part of HTTP Basic Auth. The examples on this page will leave out the token. For examples of calls using the token, see the Getting Started section of the API Overview. For the curl calls in the examples listed below you can add -u {your token}: to the curl command to pass the token in Basic Auth.

The account ID of your primary account is tied to your token, so for calls related to your primary account you do not need to include the account ID in API calls. For calls related to your SubAccounts, the account ID of the SubAccount should be passed in the customerid parameter. This is discussed further in the Record IDs section of the API Overview.

The reference list below is organized by Resource and Action. The following resources are supported:

  • notifications
  • GET

If the action is GET, PUT, or DELETE, you can use the HTTP method to specify them directly. For other actions, include a parameter "action" to set the action. Alternatively, you can also set GET, PUT, and DELETE using the action parameter as well, which is useful if you are working in an environment that does not easily allow you to set the HTTP method.

The API supports two ways of passing in the parameters. You can put them in the querystring as shown in the accounts PUT example, or you can send them in a JSON object named json, as shown in the contacts PUT example. The two syntaxes are interchangeable. In both cases, you only need to include fields listed as "required." "Optional" fields only need to be included if you are setting the value for that parameter.

If you have any questions, get in touch at, or use our Contact form.