Guide

Getting started

Every call goes to the API's base URL, with your API token:

https://your-domain/api/v1

Your token is on the API page of your account. Check that it works:

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

The answer is the user the token belongs to.

Send the fields of a request as a form (application/x-www-form-urlencoded) or as JSON (Content-Type: application/json). The bulk import takes JSON. In a form, send a yes/no field as 1 or 0. Answers are JSON, except the log downloads, which are files.

Lists, contacts and campaigns are named by their uid, a 13-character identifier such as 6adaabbf98847. A contact is named by its id, a number: the same address has a different id in each list it belongs to.