Skip to Content
PUT
/api/v1/accounts/{accountId}/templates/{slug}/variants/{lang}

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.

Authorization

bearerAuth
headerAuthorizationBearer <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: [].

Path Parameters

accountId*string

Account ULID identifier.

slug*string

The template's name within this account.

Match^[a-z0-9][a-z0-9_-]*$
Length1 <= length <= 64
lang*string

Language tag, e.g. en or de-AT. Stored lowercased.

Match^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$
Length2 <= length <= 35

Request Body

application/json
  1. body
html?string|null
subject*string
Length1 <= length <= 500
text*string
Length1 <= length

Response Body

Stored

application/json
  1. response
changed*boolean

False when this language already held exactly this copy: nothing was written

lang*string
slug*string
stored*true
Value intrue
Example Request
curl -X PUT 'https://api.open.email/api/v1/accounts/string/templates/string/variants/string' \
  -H 'Content-Type: application/json' \
  -d '{
  "subject": "string",
  "text": "string"
}'
Example Response
{
  "changed": true,
  "lang": "string",
  "slug": "string",
  "stored": true
}