Skip to Content
POST
/api/v1/accounts/{accountId}/templates

Registers a template. The From address must be one this account may already send as; the copy is added per language afterwards.

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.

Request Body

application/json
  1. body
defaultLang?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
from*string
Formatemail
Lengthlength <= 320
name*string
Length1 <= length <= 200
replyTo?|
Formatemail
Lengthlength <= 320
slug*string

The template's name within this account.

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

Documentation and dummy data per variable. Never a schema: a body may use what this omits.

Response Body

Created

application/json
  1. response
createdAt*integer
defaultLang*string
from*|

The From address; always set on a template this API created

languages*array<string>

The languages this template has copy for

name*string
replyTo*string|null
slug*string
updatedAt*integer
variables*
version*integer

Bumped by every write that changes what a send would produce

Example Request
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"
}'
Example Response
{
  "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
}