Documentation
Send a message
The POST /v1/emails contract, fields and response semantics.
Accepts a message and returns 202 only after the message, per-recipient deliveries, idempotency key and outbox event commit in one transaction.
| Field | Type | Notes |
|---|---|---|
| from | string | Must be on a verified domain in your workspace |
| to | string | string[] | Max 50 recipients per message |
| subject | string | Required, ≤ 500 characters |
| reply_to | string | Optional Reply-To address; display name allowed. Use this instead of a custom Reply-To header |
| html / text | string | At least one required; html ≤ 1 MiB |
| stream | string | transactional (default) or marketing |
| tags | object | String key/value pairs, echoed in events |
| headers | object | Additional headers. From, To, Subject, Date, Message-ID and Reply-To are set by the API |
| template_id | string | Resolve subject, html and text from a saved template |
| template_data | object | Values for {{variable}} placeholders |
| cc / bcc | string | string[] | Additional recipients; BCC is omitted from headers |
| scheduled_at | string | RFC3339 or natural language like "in 2 hours" |
| topic | string | Per-message topic; contacts opted out are failed |
| attachments | array | Up to 20 files, 40 MiB total; base64 content or public HTTPS path, optional content_id for inline CID |
| test_mode | boolean | Accept and record without attempting SMTP delivery |
202 Accepted
{"id": "msg_2f9c…", "status": "accepted", "recipients": 1}The dashboard compose screen at /app/send supports the same CC/BCC, attachments, topic and scheduling fields without an API key. Fetch state with GET /v1/emails/{id} orGET /v1/messages/{id}/deliveries.
Need the full API surface? OpenAPI 3.1.