Automations

Edit an automation

PATCH
/api/v1/automations/{id}

Updates the trigger, filter, priority, exit event or name. Trigger and filter changes affect FUTURE enrollments only — contacts mid-run keep advancing through the tree they enrolled into. Steps are edited through the /steps endpoints.

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
name?string
Length2 <= length <= 120
trigger_event?string

New trigger. Affects FUTURE enrollments only.

Length1 <= length <= 120
trigger_filter?array<>||

New filter, or null to clear it (every occurrence enrolls).

priority?integer

Lower runs first when several automations match.

Range0 <= value <= 1000
exclusive?boolean
exit_events?array<>|

Events that end an in-flight run early, ORed. Replaces exit_event; [] or null clears.

exit_event?|

Deprecated single-event form, still accepted. Prefer exit_events. null clears.

allow_reenrollment?boolean
reenrollment_cooldown_seconds?integer
Range0 <= value <= 9007199254740991

Response Body

Automation updated.

application/json
  1. response
id?string
Example Request
curl -X PATCH 'https://sendandretain.com/api/v1/automations/string' \  -H 'Content-Type: application/json' \  -d '{  "priority": 50,  "exit_events": [    "subscription.resumed"  ]}'
Example Response
{  "id": "string"}