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

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.

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

Request Body

application/json
  1. 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.

Match^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$
Length2 <= length <= 35
preview?boolean
recipient?|null
vars?

Response Body

The rendered message

application/json
  1. response
html*string|null
langUsed*string
slug*string
source*string

draft when the call carried copy to preview, stored when it rendered the template's own copy

Value in"stored""draft"
subject*string
templateVersion*integer
text*string
variables*array<>
Example Request
curl -X POST 'https://api.open.email/api/v1/accounts/string/templates/string/render' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example Response
{
  "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"
    }
  ]
}