Templates

Render a template

POST
/api/v1/templates/{slug}/render

Compiles and renders a version and returns the HTML, plain text and subject. No side effects — nothing is sent. This is the authoring inner loop: compile and render failures come back as invalid_request carrying the verbatim diagnostics, so you can fix the source and retry.

Authorization

bearerAuth write
headerAuthorizationBearer <token>

An API key from the dashboard under Settings → API keys, sent as Authorization: Bearer aem_….

Authorization has two independent axes.

The scope is ranked — a key satisfies any requirement at or below its own tier:

  • read — see messages, contacts and metrics. Changes nothing, and cannot send.
  • write — everything read does, plus managing templates, contacts, automations, segments and suppressions. This is what editing a template needs.
  • admin — everything write does, plus sending configuration: domains, senders, webhook registration, kill switch, daily cap, brand.

There is no approve scope. It was a rung once; it is not one now, and a key requested with it is rejected.

The approval grant (can_approve) is a separate boolean, not a rung. Delivering mail to a real inbox needs write and the grant. Keeping them on separate axes is what makes the review gate a control rather than a convention: a key that may propose is not automatically a key that may approve its own proposal.

Give your application the lowest tier that works. Most need write and the grant — the dashboard mints that combination as Send + manage; Manage only is the same rung with the grant withheld.

Scope: write

Path Parameters

slug*string

Template slug.

Request Body

application/json
  1. body
version?integer

Version to render. Omit for the latest.

Range0 < value <= 9007199254740991
props?

Values for the template's variables. Omit to render with generated example props.

Response Body

Rendered output.

application/json
  1. response
slug?string
version?integer
subject?string
html?string
text?string
props_used?

The props actually rendered with — generated examples when you passed none.

Example Request
curl -X POST 'https://sendandretain.com/api/v1/templates/string/render' \  -H 'Content-Type: application/json' \  -d '{  "props": {    "firstName": "Jane"  }}'
Example Response
{  "slug": "string",  "version": 2,  "subject": "Welcome to Acme, Jane",  "html": "string",  "text": "string",  "props_used": {}}