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
Get the API token of a user
POST
/api/v1/user/login
No API token needed.
Trades an email address and a password for the user's API token. No token is needed to call it. Limited to 5 calls a minute from one IP address.
Request body application/x-www-form-urlencoded
email
string (email)
required
password
string
required
Responses
200
The user's API token.
401
No user has this email address and password.
422
The email address or the password is missing.
429
More than 5 calls in a minute from this IP address.
Get the API token of a user
1
2
3
4
curl -X POST 'https://your-domain/api/v1/user/login' \
-H "Accept: application/json" \
--data-urlencode 'email=user@example.com' \
--data-urlencode 'password=your-password'
Response
{
"api_token": "YOUR_API_TOKEN"
}
{
"error": "Invalid credentials"
}
{
"message": "The password field is required.",
"errors": {
"password": [
"The password field is required."
]
}
}
{
"message": "Too Many Attempts."
}