Create a mail template
Registers a template. The From address must be one this account may already send as; the copy is added per language afterwards.
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.
application/json- body
defaultLang?stringLanguage tag, e.g. en or de-AT. Stored lowercased.
^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$2 <= length <= 35from*stringemaillength <= 320name*string1 <= length <= 200replyTo?|emaillength <= 320slug*stringThe template's name within this account.
^[a-z0-9][a-z0-9_-]*$1 <= length <= 64variables?Documentation and dummy data per variable. Never a schema: a body may use what this omits.
Created
application/json- response
createdAt*integerdefaultLang*stringfrom*|The From address; always set on a template this API created
languages*array<string>The languages this template has copy for
name*stringreplyTo*string|nullslug*stringupdatedAt*integervariables*version*integerBumped by every write that changes what a send would produce
curl -X POST 'https://api.open.email/api/v1/accounts/string/templates' \
-H 'Content-Type: application/json' \
-d '{
"from": "user@example.com",
"name": "string",
"slug": "string"
}'{
"createdAt": 0,
"defaultLang": "string",
"from": "string",
"languages": [
"string"
],
"name": "string",
"replyTo": "string",
"slug": "string",
"updatedAt": 0,
"variables": {
"property1": {
"description": "string",
"sample": "string"
},
"property2": {
"description": "string",
"sample": "string"
}
},
"version": 0
}List this account's mail templates GET
Every stored template this account owns, with the languages each one has copy for. Needs an unscoped account key: a domain-scoped one is refused on the whole…
Get one mail template GET
The template's metadata, its variable declarations, and the stored copy for every language it has.