SuppressionList API Overview

This is technical documentation and the target audience is anyone who intends to integrate another platform with SuppressionList. Everything a developer needs to integrate with SuppressionList is found in this documentation. Please contact our support team if you find inconsistencies or need clarification. We want this documentation to be clear and easy to use, and we’re happy to get your feedback.

The Examples

This documentation contains an example for every API call. The examples use the ubiquitous curl command, which is widely available on *NIX systems and Mac OS X. If you only work on Microsoft platforms, then curl may not be familiar to you and you may therefore find the examples confusing. But don’t despair, curl is also available for Windows, and is easy to learn. You can download curl at http://curl.haxx.se/download.html.

We recommend that you know how the curl command works before attempting to understand the examples. But even if you don’t, it’s still possible to decipher the examples. Here are the curl arguments you need to know:

• -x: The HTTP method to use, i.e.
  -X POST to perform an HTTP POST to add an item to a list.
  -X DELETE to perform an HTTP DELETE to remove an item from a list.
• -h: Add a header, i.e. -H ‘Content-Type: application/json’ to set the request content type to “application/json”
• -d: Set the HTTP request body, i.e. -d ‘{“name”: “my_list”}’ to put a JSON document in the request body
• -u: Set the HTTP Basic Authentication credentials, i.e. -u[username]:[API key].
  The username is always “API”, and your account’s API key, which you can find in the “Account Settings” tab of the “My Account” tab at https://account.activeprospect.com.
  For example, if your account’s API key is “12345”, use -uAPI:12345

Authentication

Authentication is performed using Basic Authentication. This type of authentication is ubiquitous and secure when used over SSL. All requests to our API must be performed over SSL. The username portion of the Basic Authentication is ignored. The password must be your API key. Requests made without Basic Authentication will receive an HTTP 403 (Forbidden) response.