Skip to the documentation
API

Automation starters

The starting points the app offers when somebody makes an automation: a welcome series, a trial follow-up, a birthday email and a win-back. They ship with the product, so the list is the same for every workspace.

GET/automations/starters

Runs the real call on your workspace.

GET /automations/starters

The starting points the app offers when somebody makes an automation: a welcome series, a trial follow-up, a birthday email and a win-back. They ship with the product, so the list is the same for every workspace.

Example

Needs automations:read. Each starter carries its definition, with the audience, template and sender left for you to fill in.

curl
curl "$OE/automations/starters" -H "$AUTH"
Response
{  "object": "list",  "data": [    {      "object": "automation_starter",      "slug": "welcome-series",      "name": "Welcome series",      "description": "Greet people who join an audience, then follow up with those who did not click.",      "definition": { "trigger": { "kind": "audience_joined", "…": "…" }, "entry": "welcome", "steps": ["…"] }    }  ]}

Pass a slug as starter when you create an automation, and the server copies the starter for you.

Reference