Render a template without sending it
Returns the subject and bodies a send would produce, and a report on every variable: what the declaration says, which body uses it, and whether a sample filled it. With preview, any variable the caller omits is filled from its declared sample. With draft, it renders that copy instead of the stored one, under the checks a save makes, and stores nothing: saving a variant publishes it, so this is how copy is seen before it is live.
bearerAuthAuthorizationBearer <token>Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.
oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.
oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.
Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].
accountId*stringAccount ULID identifier.
slug*stringThe template's name within this account.
^[a-z0-9][a-z0-9_-]*$1 <= length <= 64application/json- body
draft?|Copy not stored yet, rendered in the language asked for (else the template's default) with no fallback, since it IS that language's copy. Held to the checks a save makes, so a broken draft gets the refusal saving it would; nothing is written.
lang?|Language tag, e.g. en or de-AT. Stored lowercased.
^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$2 <= length <= 35preview?booleanrecipient?|nullvars?The rendered message
application/json- response
html*string|nulllangUsed*stringslug*stringsource*stringdraft when the call carried copy to preview, stored when it rendered the template's own copy
"stored""draft"subject*stringtemplateVersion*integertext*stringvariables*array<>curl -X POST 'https://api.open.email/api/v1/accounts/string/templates/string/render' \
-H 'Content-Type: application/json' \
-d '{}'{
"html": "string",
"langUsed": "string",
"slug": "string",
"source": "stored",
"subject": "string",
"templateVersion": 0,
"text": "string",
"variables": [
{
"bodies": [
"subject"
],
"description": "string",
"filledFromSample": true,
"name": "string",
"sample": "string"
}
]
}Remove one language's copy DELETE
Drops a language. The template keeps its other languages; a send asking for this one falls to the template's default language, or is refused when there is none.
Send a template to one or more recipients POST
Renders the template once per recipient, with that recipient's own variables layered over the shared ones, and sends each as its own message, now. There is no…