Automations

Activate or pause

POST
/api/v1/automations/{id}/status

This is the call that starts real sending. Activating requires confirm: true AND passes a server-side check that every send step points at a PUBLISHED template and the lane tree is intact — a failure comes back as template_not_published. Pausing requires neither. Run GET /api/v1/automations/{id}/preflight first to see what would block.

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.

Request Body

application/json
  1. body
status*string

active starts real sending; paused stops it.

Value in"active""paused"
confirm?boolean

Required (true) to activate. Pausing needs no confirmation.

Response Body

Status changed.

application/json
  1. response
id?string
status?string
Example Request
curl -X POST 'https://sendandretain.com/api/v1/automations/string/status' \  -H 'Content-Type: application/json' \  -d '{  "status": "active",  "confirm": true}'
Example Response
{  "id": "string",  "status": "active"}