Skip to content

API Overview

Dispatch exposes a REST API at /api/v1/. The developer API is authenticated with an API key; account management (billing, domain creation, creating API keys themselves) happens in the dashboard.

Base URL

EnvironmentURL
Devhttps://dispatch-dev.techtranslab.com
Prodhttps://dispatch.techtranslab.com

Authentication

Authorization: Bearer {api_key}

See Authentication for scopes and the domain allowlist.

Endpoints

EndpointScope
POST /emailsemail:send
POST /emails/batchemail:send
POST /campaignsemail:send
POST /messages/:id/cancelemail:send
GET /messagesemail:read
GET /messages/:idemail:read
GET /messages/:id/eventsemail:read
GET /messages/statsemail:read
GET /domainsdomain:read

Health Check

GET /health

Returns 200 OK when the service is healthy.

Error Format

json
{ "error": "CODE", "message": "Human-readable detail" }
HTTPCommon codes
400BAD_REQUEST, INVALID_FROM_ADDRESS, DOMAIN_NOT_FOUND, DOMAIN_NOT_VERIFIED, NOT_SCHEDULABLE, NOT_CANCELLABLE
401UNAUTHORIZED
403INSUFFICIENT_SCOPE, DOMAIN_NOT_ALLOWED, FORBIDDEN
404NOT_FOUND
409ALREADY_PROCESSED
429Rate limited
500INTERNAL_ERROR

Pagination

List endpoints accept page and per_page:

GET /api/v1/messages?page=1&per_page=20

Response includes total and matches the requested page.

TechTrans Lab