Guide

Authentication

Send your API token with every request, in a header:

curl -H "Accept: application/json" \
     -H "Authorization: Bearer YOUR_API_TOKEN" \
     https://your-domain/api/v1/lists

or as the api_token query parameter:

curl -H "Accept: application/json" \
     "https://your-domain/api/v1/lists?api_token=YOUR_API_TOKEN"

Always send Accept: application/json. Without it, a missing or wrong token is answered with a redirect to the sign-in page instead of a 401.

A customer's token reaches that customer's lists, contacts, campaigns and automations. An admin's token reaches the admin calls: customers, subscriptions, sending servers and maintenance. What each admin token may do follows the permissions of its admin.

Keep the token secret: it acts as its user, and the login-token call turns it into a signed-in session. To change a token, generate a new one on the API page.