Send a template to one or more recipients
Renders the template once per recipient, with that recipient's own variables layered over the shared ones, and sends each as its own message, now. There is no sendAt: scheduling belongs to the mailbox product, and an unknown key is refused.
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 <= 64x-delivery-id?stringIdempotency key. Each recipient's message derives its own from this, the template and the recipient's address, so a retry converges per recipient whatever the order or subset of the list it carries, and the same key used for a different template is a different message. At most 200 characters; # is reserved. A retry does not get around a sending hold: while the sender is paused or disabled it is refused like any submission, and once the hold lifts it continues without a second charge.
application/json- body
bounce?booleanheaders?Extra headers for every message. Auto-Submitted, X-Auto-Response-Suppress and Content-Language are the route's own and are refused in any spelling.
lang?|Language tag, e.g. en or de-AT. Stored lowercased.
^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$2 <= length <= 35replyTo?|emaillength <= 320save?booleanKeep a Sent copy. Default FALSE here, unlike /send.
to*array<>One message is built per entry, and an address may appear once. No cc or bcc: personalisation makes shared bytes meaningless.
1 <= items <= 50vars?Every recipient was accepted
application/json- response
deliveryId*stringThe batch id; retry with it to converge only the failures
langUsed*stringresults*array<>slug*stringtemplateVersion*integercurl -X POST 'https://api.open.email/api/v1/accounts/string/templates/string/send' \
-H 'Content-Type: application/json' \
-d '{
"to": [
{
"email": "user@example.com"
}
]
}'{
"deliveryId": "string",
"langUsed": "string",
"results": [
{
"address": "string",
"deliveryId": "string",
"error": "string",
"retryAfterSeconds": 0,
"sentCopy": "saved",
"status": "delivered"
}
],
"slug": "string",
"templateVersion": 0
}Render a template without sending it POST
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…
System
Operator-only: the deployment panel (queues, dead letters, fleet traffic, purges) plus the public liveness check.