API Documentation

About The API

The API is a set of methods that enable you to use code to perform operations on system objects, such as Lists and Folders. The API enables you to extend the system's capabilities and integrate it with third party applications such as your CRM or CMS.

Getting Started

This section helps you get up and running with the API. Please through this page and follow the steps we have included. If you are already using the API, this page will direct you accordingly.

Use Cases

Concepts of how you may like to build your API integration. This page covers off the most common use cases for the API.

API References

The API Reference Guide explains how the API works and how to use all of its available methods. If you are a developer who is implementing the API, this documentation is intended for you.

Note to Existing API Users

We've upgraded our API to Version 3.0 which means there are lots of exciting improvements. But first things first, even though you are already integrated with a previous version, everything will still work exactly as it did before.

  • Version 3.0 differs from the API's previous session-based versions that required you to call the login() method first. API keys are not compatible with the old login() authentication method, and you cannot use the two together.

    Please do not use the login() method with new development.

  • Many new methods are available in Version 3.0, and some have changed. Please view the Changes made to the API for Version 3.0 and go to the index to see what methods are now available.

  • The previous Campaign methods have not been removed, but are now referred to as Batch methods. Campaigns now represent what we previously called Automation. Currently there are no 'Automation' methods in the API.

Help & Support

If you need assistance with your API Integration, our Support team is here to help. You can access the Support team directly via the Knowledge Center - Just ask your question here and the team will usually provide a response within minutes.

If you don't have access to Knowledge Centre, please email hello@brandmail.com.au with as much information as possible including any code relevant.