Documentation

Templates & test mode

Reusable templates, variables, test mode and test-only keys.

Save a subject and body with {{variable}} placeholders using the rich editor or HTML view, then send with template_id and template_data. Omitted fields are filled from the template. Values are substituted literally. Preview a template with real data through the dashboard or POST /v1/templates/{id}/preview before sending.

send with a template
POST /v1/emails
{
  "from": "Acme <[email protected]>",
  "to": ["[email protected]"],
  "template_id": "tpl_...",
  "template_data": { "name": "Ada" },
  "test_mode": true
}

Test mode commits and records the message, but marks each delivery suppressed with test mode: no SMTP delivery. It does not consume usage. Send to [email protected], [email protected], [email protected], [email protected], [email protected] or [email protected] to generate synthetic delivery outcomes and webhook events without touching a real mailbox. Create a test-only API key to force test mode on every request, so staging or an agent cannot send real mail. The per-message test_mode flag remains available for one-off checks. The dashboard simulator at /app/test-mode and POST /v1/test-mode/simulate report the sender domain, suppression, unsubscribe, double opt-in and quota outcome without accepting a message. Save a form state as a scenario to rerun the same check later.

Need the full API surface? OpenAPI 3.1.