The main endpoints, in one index.

• GET/api/auth/meCurrent user + workspaces
• POST/api/auth/loginEmail + password authentication
• POST/api/auth/signupCreate user + first workspace
• GET/api/tokensList API tokens for the active workspace
• POST/api/tokensMint a new API token (plaintext returned once)
• POST/api/tokens/{id}/revokeRevoke an API token
• POST/api/tokens/{id}/rotateRotate to a new token under the same name

• POST/api/workspacesCreate a new workspace (user becomes owner)
• PATCH/api/workspaces/{id}Rename a workspace / update its settings
• GET/api/workspaces/{id}/membersList members + their roles
• POST/api/workspaces/{id}/membersInvite a member by email
• DELETE/api/workspaces/{id}/members/{user_id}Remove a member

• GET/api/domainsList sending domains
• POST/api/domainsAdd a domain (returns DNS records to publish)
• POST/api/domains/{id}/verifyRe-run multi-resolver DNS verification
• POST/api/domains/{id}/rotate-dkimGenerate a fresh DKIM keypair
• POST/api/domains/{id}/dmarc/advanceBump DMARC progression to the next step
• POST/api/checkPublic deliverability check (no auth, rate-limited)

• POST/api/transactional/sendFire a journey for one recipient: trigger_key, to, variables, idempotency_key
• GET/api/transactional/journeysList journeys and their trigger keys
• POST/api/transactional/journeysCreate a journey
• GET/api/transactional/messagesMessage stream: filter by status, mode or trigger_key
• GET/api/transactional/messages/{id}One message with its final rendered HTML

• POST/api/campaignsCreate a campaign draft
• POST/api/campaigns/sendCreate and send a campaign (needs a name and a draft_id)
• POST/api/campaigns/{id}/cancelCancel a scheduled or in-flight campaign
• GET/api/campaigns/{id}Campaign metadata + send progress
• GET/api/campaigns/{id}/reportReply rate, replies by meaning, attributed revenue

• GET/api/mailboxesList connected mailboxes
• POST/api/mailboxes/gmail/callbackComplete Gmail OAuth flow
• POST/api/mailboxes/outlook/callbackComplete Microsoft Graph OAuth flow
• POST/api/mailboxes/imap/connectConnect an IMAP mailbox by credentials
• DELETE/api/mailboxes/{id}Disconnect a mailbox

• GET/api/repliesList recent replies with filters
• POST/api/replies/ingestManually ingest a reply (for testing)
• POST/api/inbound/{workspace_id}/emailWebhook for external inbound parsers
• GET/api/contactsList contacts
• POST/api/contactsCreate or upsert a contact

• GET/api/webhooks/events/samplesEvery event type with a generated sample payload
• GET/api/webhooksList webhook subscriptions
• POST/api/webhooksCreate a subscription (signing secret returned once)
• PATCH/api/webhooks/{id}Update URL / events / status
• POST/api/webhooks/{id}/rotate-secretGenerate a new signing secret
• POST/api/webhooks/{id}/testFire a test.ping event at this endpoint
• GET/api/webhooks/{id}/deliveriesRecent delivery attempts + status
• POST/api/webhooks/deliveries/{id}/replayRe-queue a failed delivery

• GET/api/automationsList automations
• POST/api/automationsCreate automation with trigger + actions
• PATCH/api/automations/{id}Update automation
• DELETE/api/automations/{id}Delete automation
• POST/api/automation-flows/eventsFire an API-event trigger: enrols one recipient in the active transactional automation with that trigger_key (202; idempotent on idempotency_key)

• An API key leaked: spot it, contain it, replace itWhat to do in the first hour after an API key leaks, and how scoped keys keep the damage small.
• Retry a transactional email without sending it twiceChoose an idempotency key from the event, retry safely, and keep a teammate from renaming a live trigger key.
• Start an email automation from your app with one API callFire a flow from your code with one POST, then let marketing change the emails behind it without a deploy.
• Marketing vs transactional email: what the label changesThree questions that settle the label, and the headers, do-not-send rules and limits that follow from it.

All guides →