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
Errors
The HTTP status says what went wrong. The body says why, in one of these shapes:
- a message:
{"message": "Campaign not found"}, sometimes with"status": 0or"status": "error"; - the fields that failed, each with its messages:
{"from_email": ["The from email must be a valid email address."]}; - for the newer calls, both:
{"message": "…", "errors": {"type": ["…"]}}.
Each call lists the statuses it answers with. The most common:
| Status | Meaning |
|---|---|
400 |
The request misses something the call needs. |
401 |
The token is missing or wrong, or its user may not act on this object. |
403 |
The call refuses the request: a field is wrong, or the account may not do this. |
404 |
Nothing has this uid or id. |
409 |
The object is not in a state that allows the call (already subscribed, archived, …). |
422 |
The request is well formed but refused; the message says why. |
429 |
Too many calls; wait a minute. |