The Engage API

The Engage API

We are constantly expanding the functionality of the API as we respond to the needs of customers. As a result, some API functions are not yet documented or published. For a list of the functions that are documented, and examples of how the API can be used, see the API documentation here.

If what you're looking for is not there - just ask

If you're looking to use the API to access Engage functionality please let us know. Chances are there's already an API function to do what you need - even though it may not yet be documented. And if there isn't, there's a good chance we can add it for you easily.

Keep your contacts in sync

You can add a contact to an Engage database via the API or update or delete the details of an existing contact. A common example of where you might want to use the API is where you have a login form on your website. Your users log in and want to update their email preferences - and you want to update your Engage contact details as they do so.

Using the Engage API to programmatically update, create or delete contact records allows you to keep your Engage database in sync with your existing customer databases or CRM system.

When you send email newsletters you simply log in to Engage and manage the send process - no data imports or updates are required. Or you can access API functions programmatically to do that too.

Use the Engage API for messaging

Engage's API TXT Gateway functions allows you to send and receive TXT messages.

Similarly you can use the API to send emails - either individually or in batches. Sends can be actioned immediately or scheduled for later delivery.

The API also allows you to pause or cancel mail-outs, and provides access to all the results of mail-outs, such as bounced messages, confirmed reads, links clicked, etc.

Messages sent via the API are sent through Engage's white-listed delivery server, so you get improved delivery rates and your emails don't wind up in the recipient's spam folder.

Use the API to manage your Engage database

Each Engage account has a database. You can set up fields and field types and set rules around the database such the unique key for the database.

In addition to your unique key, Engage automatically creates a GUID for each contact which is unique. Calls to update a contact in the Engage database via the API can either use your unique key or the Engage GUID.

You will need your database ID in order to use the database API. Contact us for your database ID.

You will also need a username and password for each API call. Log in to Engage and click users to create a user you can use for this purpose - or contact us and we can help you out.

Use the ContactController to manage contacts in the database.

Use the API to manage webforms and triggered emails

You can create web forms in Engage. With the API you can then interact with these forms programmatically. For instance you can setup triggered emails in Engage which are sent once a form is completed.

Use the FormController, PostController and RenderController to access web forms via the API.

Access history via the API

An extensive history is recorded against each contact in the database. You can create or access history events using the HistoryController functions of the API.

Engage API documentation

Documentation is located here. This API is evolving constantly so if there isn't a function to do what you need shown in this documentation, contact us. We may have already built the function but it is not yet documented. Or we may be able to simply add the functionality you need.