Documentation
Automations
Audience, click, update and inbound triggers with waits, sends, conditions and routes.
An automation is a triggered sequence of wait and send steps. By default contacts enroll when they join the audience; contacts in a double opt-in audience enroll after they confirm. A second trigger enrolls a contact when they click a tracked campaign link, optionally matching a URL substring. A third trigger starts the journey when the contact is updated; a completed enrollment restarts on a later update. A fourth trigger starts it when a known contact emails one of the workspace inboxes, and a fifth handles mail accepted by a generic inbound route. Each enrollment advances independently with durable state, so a worker restart does not reset a journey.
Send steps can carry a condition on an attribute, open state or click state. If the contact does not match, that send is skipped and the journey continues. A route step branches the enrollment into another active automation on match or miss, which is how if/else journeys are composed.
Activation can optionally enroll the current audience. The last step must send or route. Before every send the runner re-checks contact status, unsubscribe state, suppression, topic preferences and plan quota. Campaign preferences and one-click unsubscribe headers are included, and the send source is automation.
POST /v1/automations
{
"name": "Welcome series",
"audience_id": "aud_…",
"from": "[email protected]",
"from_name": "Acme",
"topic": "product-updates",
"steps": [
{ "kind": "wait", "delay_minutes": 60 },
{ "kind": "send",
"subject": "Welcome, {{name}}",
"html": "<p>Thanks for joining.</p>" },
{ "kind": "wait", "delay_minutes": 1440 },
{ "kind": "send",
"subject": "A quick tip",
"html": "<p>Here is one thing to try.</p>" }
]
}
POST /v1/automations/atm_…/activate # {"enroll_existing": false}
POST /v1/automations/atm_…/pause
GET /v1/automations/atm_… # steps and enrollment countsNeed the full API surface? OpenAPI 3.1.