API reference

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/v1

Authenticate with a bearer key on every request. The chip on each endpoint page shows the minimum key scope it needs.

Endpoints

MethodPathDescriptionScope
POST/v1/emailsSend a single transactional emailsending
GET/v1/contactsList contactsfull
POST/v1/contactsCreate a contactfull
GET/v1/contacts/{id}Retrieve a contactfull
PATCH/v1/contacts/{id}Update a contactfull
DELETE/v1/contacts/{id}Delete a contactfull
GET/v1/groupsList groupsfull
POST/v1/groupsCreate a groupfull
GET/v1/groups/{id}Retrieve a groupfull
PATCH/v1/groups/{id}Update a groupfull
POST/v1/groups/{id}/contactsAdd contacts to a groupfull
DELETE/v1/groups/{id}Delete a groupfull
GET/v1/campaignsList campaignsfull
POST/v1/campaigns/{id}/sendStart sending a campaignfull
GET/v1/templatesList templatesfull
GET/v1/templates/{id}Retrieve a templatefull
GET/v1/projects/{id}/domainsList a project's domainsfull
GET/v1/projects/{id}/domains/{domain}Retrieve a domainfull