Reference

API Reference

The PostMTA REST API. Base URL: https://api.postmta.com/v1. All requests use JSON.

Messages

MethodEndpointDescription
POST/messages/sendSend a transactional email
GET/messages/{id}Get message status
GET/messagesList messages
DELETE/messages/{id}Cancel scheduled message

Domains

MethodEndpointDescription
POST/domainsAdd a sending domain
GET/domainsList all domains
DELETE/domains/{domain}Delete a domain
POST/domains/{domain}/verifyVerify DNS records

Webhooks

MethodEndpointDescription
POST/webhooksCreate a webhook
GET/webhooksList webhooks
DELETE/webhooks/{id}Delete a webhook
POST/webhooks/{id}/testSend test event

IP Pools

MethodEndpointDescription
POST/ip-poolsCreate a pool
GET/ip-poolsList pools
POST/ip-pools/{name}/warmupStart IP warm-up

Analytics

MethodEndpointDescription
GET/analytics/statsOverall stats
GET/analytics/timeseriesTime-series data
GET/analytics/breakdown/domainsDomain breakdown
GET/analytics/exportExport data

Pagination

List endpoints use cursor-based pagination:

GET /v1/messages?limit=25&cursor=msg_01HXabc...
{"data":[...],"pagination":{"has_more":true,"next_cursor":"msg_01HXdef...","total":10432}}

See Error Codes for the full list of error codes.