Mail Reference

Send emails, send document emails, and receive webhooks.

• POST/api/v1/mail/send— Send an email
• POST/api/v1/mail/send-document— Send a document email
• POST/api/v1/mail/webhooks/sendgrid— Receive SendGrid webhook

Retrieve sent message history.

• GET/api/v1/mail/messages— List sent messages

Manage and import mail delivery contacts.

• GET/api/v1/mail/contacts— List contacts
• POST/api/v1/mail/contacts— Create a contact
• GET/api/v1/mail/contacts/{id}— Get a contact
• PATCH/api/v1/mail/contacts/{id}— Update a contact
• DELETE/api/v1/mail/contacts/{id}— Delete a contact
• POST/api/v1/mail/contacts/import— Import contacts

Create and manage mailing lists and their members.

• GET/api/v1/mail/lists— List mailing lists
• POST/api/v1/mail/lists— Create a list
• GET/api/v1/mail/lists/{id}— Get a list
• DELETE/api/v1/mail/lists/{id}— Delete a list
• GET/api/v1/mail/lists/{id}/members— List members of a list
• POST/api/v1/mail/lists/{id}/members— Add a member to a list
• DELETE/api/v1/mail/lists/{id}/members/{contactId}— Remove a member from a list

Create, send, and view statistics for email campaigns.

• GET/api/v1/mail/campaigns— List campaigns
• POST/api/v1/mail/campaigns— Create a campaign
• GET/api/v1/mail/campaigns/{id}— Get a campaign
• PATCH/api/v1/mail/campaigns/{id}— Update a campaign
• DELETE/api/v1/mail/campaigns/{id}— Delete a campaign
• POST/api/v1/mail/campaigns/{id}/send— Send a campaign
• GET/api/v1/mail/campaigns/{id}/stats— Get campaign stats

Create, manage, and activate scenario-based email delivery such as drip campaigns.

• GET/api/v1/mail/scenarios— List scenarios
• POST/api/v1/mail/scenarios— Create a scenario
• GET/api/v1/mail/scenarios/{id}— Get a scenario
• PATCH/api/v1/mail/scenarios/{id}— Update a scenario
• DELETE/api/v1/mail/scenarios/{id}— Delete a scenario
• POST/api/v1/mail/scenarios/{id}/activate— Activate a scenario
• POST/api/v1/mail/scenarios/{id}/pause— Pause a scenario

Add, update, and delete individual steps (send email, wait, etc.) within a scenario.

• POST/api/v1/mail/scenarios/{id}/steps— Create a step
• PATCH/api/v1/mail/scenarios/{id}/steps/{stepId}— Update a step
• DELETE/api/v1/mail/scenarios/{id}/steps/{stepId}— Delete a step

Retrieve mail delivery analytics and dashboard data.

• GET/api/v1/mail/analytics/overview— Get analytics overview
• GET/api/v1/mail/dashboard— Get dashboard

View change history of mail delivery data.

• GET/api/v1/mail/audit-logs— List audit logs