Automations

Set up an A/B split

POST
/api/v1/automations/{id}/ab-test

Splits a send step across weighted template VERSIONS. Assignment is deterministic per contact-run, so a contact always sees the same arm. Pass variants: null to clear the split.

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
position*integer

Send step to split.

Range-9007199254740991 <= value <= 9007199254740991
variants*array<>|

Weighted template VERSIONS. Create them with PATCH /api/v1/templates/{slug} + variant_key, publish each, then attach here. null clears the split.

Response Body

Split configured.

application/json
  1. response
position?integer
variants?array<string>|null
Example Request
curl -X POST 'https://sendandretain.com/api/v1/automations/string/ab-test' \  -H 'Content-Type: application/json' \  -d '{  "position": 1,  "variants": [    {      "variantKey": "a",      "versionId": "6f2c…",      "weight": 1    },    {      "variantKey": "b",      "versionId": "9d41…",      "weight": 1    }  ]}'
Example Response
{  "position": 1,  "variants": [    "string"  ]}