Journeys API
9 endpoints. All requests need an Authorization header — see Authentication. API keys additionally need the matching scope.
| Method | Path | Description |
|---|---|---|
GET |
/api/journeys/ |
List Journeys Query: is_active. |
POST |
/api/journeys/ |
Create Journey Accepts a JSON body. |
GET |
/api/journeys/{journey_id} |
Get Journey |
PATCH |
/api/journeys/{journey_id} |
Update Journey Accepts a JSON body. |
DELETE |
/api/journeys/{journey_id} |
Delete Journey |
POST |
/api/journeys/{journey_id}/activate |
Toggle Journey |
POST |
/api/journeys/{journey_id}/steps |
Add Step Accepts a JSON body. |
PATCH |
/api/journeys/{journey_id}/steps/{step_id} |
Update Step Accepts a JSON body. |
DELETE |
/api/journeys/{journey_id}/steps/{step_id} |
Delete Step |
Try it
The full request/response schema for every endpoint is in the OpenAPI spec served by your own workspace.