API Reference
Getting Started
Core Concepts
Backend API — Guides
Frontend API — Guides
OAuth & OpenID Connect — Guides
Enterprise: SSO & SCIM — Guides
Webhooks — Guides
SDKs
Backend API (BAPI)
Frontend API (FAPI)
Dashboard API
Public API
SCIM
OIDC
Platform

Email Templates

AdminUpdated Sep 11, 2026

Email Templates

Dashboard API — authenticated by an Atlas console (platform-instance) session, not a key.

5 routes. Each row is one endpoint with its explanation and whether it honours the Idempotency-Key header.

Method & path

Idem

Explanation

GET /v1/dashboard/accounts/:accountId/instances/:instanceId/email_templates

Every template with its override and the variable schema it is validated against.

PUT /v1/dashboard/accounts/:accountId/instances/:instanceId/email_templates/:template

Store a template override. Validated by the same code the mailer applies.

DELETE /v1/dashboard/accounts/:accountId/instances/:instanceId/email_templates/:template

Drop the override and go back to the built-in template.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/email_templates/:template/preview

Compile an unsaved draft to HTML with sample values. Sends nothing.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/email_templates/:template/test_send

Send a test to the operator own verified address. The address cannot be chosen.

Was this page helpful?
Email Templates