API Reference
OIDC
Platform

Email Templates

AdminUpdated Sep 11, 2026

Email Templates

Backend API — secret key (Authorization: Bearer sk_…).

4 routes. Each row is one endpoint with its explanation, required scope, and whether it honours the Idempotency-Key header.

Method & path

Scope

Idem

Explanation

GET /v1/email_templates

instance:read

List email templates with their defaults and any instance override.

POST /v1/email_templates/:name/preview

instance:read

Render an email template (an unsaved draft if supplied, else the stored one) with SAMPLE variables — never a real code — so an agent can see the result before saving.

PUT /v1/email_templates/:name

instance:write

Override a template. Dropping a required placeholder is refused.

DELETE /v1/email_templates/:name

instance:write

Revert a template to the Atlas built-in.

Was this page helpful?