Get started

Quickstart Dashboard tour SDKs and OpenAPI AI tools Recipes Migrating to ZapSMTP

Sending

Sending email Domains & DNS setup Templates and variables Email template editor SMTP relay

Events & data

Webhook events Click actions Tracking and analytics Receiving email

Operations

Deliverability guide Testing & simulator Errors, limits & paging Teams & client accounts

API reference

Emails Domains Webhooks Click actions Templates Variables Modules, images & timers Received emails Inbound setup

List inbound domains Add an inbound domain Retrieve an inbound domain Update an inbound domain Verify MX records Delete an inbound domain List routes Create a route Retrieve a route Update a route Delete a route List forward destinations Add a forward destination Resend the confirmation Remove a forward destination Inbound stats

Suppressions Statistics Keys & SMTP credentials Logs & usage Simulator & IPs

OpenAPI 3.1 spec llms.txt

Test API keyRuns examples for real against your account. Test keys only; kept in this tab, never stored on our side. Get a key

ZapSMTP / Docs / API reference

Inbound setup

Get an instant managed address or receive on your own domain, then route messages by recipient, sender or header to a webhook, storage or rejection.

GETList inbound domains/v1/inbound/domainsList inbound domains (oldest first)..POSTAdd an inbound domain/v1/inbound/domainsCreate an inbound domain: a managed address (<slug>.<inbound zone>) or your own domain..GETRetrieve an inbound domain/v1/inbound/domains/{id}Retrieve an inbound domain..PATCHUpdate an inbound domain/v1/inbound/domains/{id}Update an inbound domain's spam policy..POSTVerify MX records/v1/inbound/domains/{id}/verifyCheck the domain's MX record now..DELETEDelete an inbound domain/v1/inbound/domains/{id}Delete an inbound domain..GETList routes/v1/inbound/routesList inbound routes in evaluation order (priority ascending, then created_at)..POSTCreate a route/v1/inbound/routesCreate an inbound route (max 100 per account)..GETRetrieve a route/v1/inbound/routes/{id}Retrieve an inbound route..PATCHUpdate a route/v1/inbound/routes/{id}Update an inbound route (partial; same fields and validation as create)..DELETEDelete a route/v1/inbound/routes/{id}Delete an inbound route..GETList forward destinations/v1/inbound/forward-destinationsList the addresses received mail can be forwarded to..POSTAdd a forward destination/v1/inbound/forward-destinationsAdd a forward destination: we email it a confirmation link; routes can forward there once its owner confirms..POSTResend the confirmation/v1/inbound/forward-destinations/{id}/resendEmail a new confirmation link (the previous one stops working)..DELETERemove a forward destination/v1/inbound/forward-destinations/{id}Remove a forward destination; routes forwarding there only store from then on..GETInbound stats/v1/inbound/statsInbound counters for the last 24 hours..