Automations
Endpoints
| Method | Endpoint | Description |
|---|---|---|
POST | Activate an automation | Activate an automation |
POST | Archive an automation | Archive an automation |
POST | Create an automation (optionally expanding a template) | Create an automation (optionally expanding a template) |
DELETE | Delete an automation (hard delete — cascades to entrypoints and runs) | Delete an automation (hard delete — cascades to entrypoints and runs) |
POST | Manually enroll a contact into an automation | Manually enroll a contact into an automation |
GET | Get an automation with its full graph | Get an automation with its full graph |
GET | Return the static catalog of node kinds, entrypoints, bindings, actions, | Return the static catalog of node kinds, entrypoints, bindings, actions, |
GET | Aggregate run metrics scoped to a single automation | Aggregate run metrics scoped to a single automation |
GET | Aggregate run metrics across the org, optionally rolled up by | Aggregate run metrics across the org, optionally rolled up by |
GET | List automations | List automations |
POST | Pause an automation | Pause an automation |
PUT | Replace the automation's graph | Replace the automation's graph |
POST | Resume a paused automation (equivalent to activate) | Resume a paused automation (equivalent to activate) |
POST | Dry-run the graph without any side effects | Dry-run the graph without any side effects |
POST | Unarchive an automation (returns it to paused state) | Unarchive an automation (returns it to paused state) |
PATCH | Update automation metadata (name, description) | Update automation metadata (name, description) |
Found something wrong? Help us improve this page.