Templates

Send a test email

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

Sends a [TEST]-prefixed copy to one inbox. Works on an unpublished draft — that's the point, you test before you publish. Test sends deliberately skip idempotency, suppression and the daily cap, but every attempt is still logged.

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
to*string

Where to send the test.

Match^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatemail
version?integer

Version to send. Omit for the latest — drafts included.

Range0 < value <= 9007199254740991
props?

Values for the template's variables.

Response Body

Test sent.

application/json
  1. response
id?string
to?string
subject?string
Example Request
curl -X POST 'https://sendandretain.com/api/v1/templates/string/test' \  -H 'Content-Type: application/json' \  -d '{  "to": "[email protected]",  "props": {    "firstName": "Jane"  }}'
Example Response
{  "id": "string",  "to": "string",  "subject": "[TEST] Welcome to Acme, Jane"}