Customer API
- Authentication
- Account
- Lists
-
Subscribers
- List the contacts of a list
- Add a contact to a list
- Get a contact
- Change a contact
- Delete a contact
- Find a contact in every list
- Add tags to a contact
- Remove tags from a contact
- Subscribe a contact
- Unsubscribe a contact
- Unsubscribe an address from a list
- Import contacts, in the request
- Import contacts, in the background
- List the recent imports of a list
- Follow an import
- Cancel an import
- Sign a contact up, without a token
-
Campaigns
- List the campaigns
- Create a campaign
- Get a campaign
- Change a campaign
- Delete a campaign
- Send a campaign
- Pause a campaign
- Resume a paused campaign
- Download the delivery log of a campaign
- Download the opens of a campaign
- Download the clicks of a campaign
- Download the bounces of a campaign
- Download the complaints of a campaign
- Download the unsubscribes of a campaign
- List the webhooks of a campaign
- Add a webhook to a campaign
- Get a webhook of a campaign
- Change a webhook of a campaign
- Delete a webhook of a campaign
- Automations
- Bounces and complaints
Admin API
SEARCH RESULT
Navigation
Go
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.