API reference
All endpoints in the v1 REST API for email, contacts, groups, campaigns, templates, and domains.
Every endpoint in the v1 API. All paths are relative to your base URL:
text
https://mailer123.com/api/v1Authenticate with a bearer key on every request. The chip on each endpoint page shows the minimum key scope it needs.
Endpoints
| Method | Path | Description | Scope |
|---|---|---|---|
POST | /v1/emails | Send a single transactional email | sending |
GET | /v1/contacts | List contacts | full |
POST | /v1/contacts | Create a contact | full |
GET | /v1/contacts/{id} | Retrieve a contact | full |
PATCH | /v1/contacts/{id} | Update a contact | full |
DELETE | /v1/contacts/{id} | Delete a contact | full |
GET | /v1/groups | List groups | full |
POST | /v1/groups | Create a group | full |
GET | /v1/groups/{id} | Retrieve a group | full |
PATCH | /v1/groups/{id} | Update a group | full |
POST | /v1/groups/{id}/contacts | Add contacts to a group | full |
DELETE | /v1/groups/{id} | Delete a group | full |
GET | /v1/campaigns | List campaigns | full |
POST | /v1/campaigns/{id}/send | Start sending a campaign | full |
GET | /v1/templates | List templates | full |
GET | /v1/templates/{id} | Retrieve a template | full |
GET | /v1/projects/{id}/domains | List a project's domains | full |
GET | /v1/projects/{id}/domains/{domain} | Retrieve a domain | full |