Automations

Pre-launch check

GET
/api/v1/automations/{id}/preflight

Read-only dry run of everything activation would validate: published templates, lane-tree integrity, a resolvable sender, a trigger something actually emits. ready reflects BLOCKING checks only. Run it in CI to catch a broken automation before anyone tries to turn it on.

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

id*string

Automation id or exact name.

Response Body

Check results.

application/json
  1. response
ready?boolean

True when nothing blocking would stop activation.

checks?array<>
Example Request
curl -X GET 'https://sendandretain.com/api/v1/automations/string/preflight'
Example Response
{  "ready": true,  "checks": [    {      "pass": true,      "blocking": true,      "label": "string",      "detail": "string"    }  ]}