Developers Portal

API Methods Overview

This is version 1 of our API. While we still fully support it, all new functionality is added to the RESTful version 3 of our API. We recommend you use that version.

README.md
Account View
Address
Automation
Branding
Campaign
Contact
Customer
Deal
Form
Group
List
Message
Segment
Settings
Single Sign On
Tags
Tasks
Site & Event Tracking
User
Webhook

Additional technical details

You can use our API to bring data into your email marketing service, create campaigns on the fly, external analysis, and so much more. We are continually building upon our API with new API features/calls to accomadate our users' needs.

Data from our API can be returned in 3 different formats:

  • Serialized Data is returned in a serialized format and can be decoded with PHP's native 
    unserialize()
  • JSON Data is returned in JSON format and can be decoded with 
    json_decode()
  • XML Write your own XML parser to handle the output

With our hosted service we have a API rate limit of 5 requests per second per account. For this reason it is wise to think about each call and whether you can utilize calls for multiple options and/or cache some of your data locally. Users with high demands can contact us for a custom rate limit solution.

The API uses HTTP status codes to indicate an error has occurred while processing a request. There are four main error status codes used by the API:

Code Description
403 The request could not be authenticated or the authenticated user is not authorized to access the requested resource.
404 The requested resource does not exist.
422 The request could not be processed, usually due to a missing or invalid parameter.
429 The user has sent too many requests in a given amount of time ("rate limiting") - contact support or account manager for more details.