What you can do
Send email
Send from a full email address or just a domain, and get back a
message_id.Send history
List sent emails with their delivery status, opens, clicks, bounce and replies.
Inbox
Read the latest replies, threaded with the email they answer.
Domains
List your connected domains and the email accounts that can send from each one.
Email verification
Check whether an address exists before you send to it.
Suppression list
List, add and remove bounced and unsubscribed addresses.
Webhooks
Get
sent, failed, open, click, bounce, unsubscribe and reply events as they happen.Base URL
Authentication
Every request needs your API key in theX-Api-Key header. To create a key, go to Integrations in the dashboard, open Deliveryman API Keys and click Manage.
Errors
The API uses standard HTTP status codes. Error responses have amessage field that explains what went wrong:
If the API is switched off, every
/api/v2/ endpoint answers 503 and a notice appears at the top of these
pages. Emails already accepted are still delivered, and unsubscribe links in emails already sent keep working.
Rate limits
Each endpoint caps how many requests your account can make per minute, and emails from one domain go out at least a minimum interval apart. See Rate limits for the numbers and how to handle a429.
Earlier API versions
The/api/v1/ endpoints for campaigns, contact lists, leads and sequences keep working and are documented under
v1 in the version picker at the top of the sidebar. V1 is in maintenance: new features only go into V2, so new
integrations should use the endpoints on this page.