Write one language's copy
Stores the subject and bodies for one language. A plain-text body is required; HTML is optional and builds a multipart/alternative message beside it.
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 <= 64lang*stringLanguage tag, e.g. en or de-AT. Stored lowercased.
^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$2 <= length <= 35application/json- body
html?string|nullsubject*string1 <= length <= 500text*string1 <= lengthStored
application/json- response
changed*booleanFalse when this language already held exactly this copy: nothing was written
lang*stringslug*stringstored*truetruecurl -X PUT 'https://api.open.email/api/v1/accounts/string/templates/string/variants/string' \
-H 'Content-Type: application/json' \
-d '{
"subject": "string",
"text": "string"
}'{
"changed": true,
"lang": "string",
"slug": "string",
"stored": true
}Delete a mail template DELETE
Removes the template and every language's copy. Messages already sent are unaffected; a send naming this slug afterwards answers not_found.
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.