Create a Journey
Creates a journey from a set of nodes, in draft state unless you pass a published state. Send nodes cannot be included until their templates exist.
Authorizations
Headers
A unique key that makes this request idempotent. If Courier receives another request with the same Idempotency-Key, it returns the stored response from the first request without performing the operation again (including the original status code and any error). Use it to safely retry POST requests after network failures without risking duplicate sends. The key is scoped to this endpoint.
Body
Request body for creating a journey.
1A single node in a journey DAG. Discriminated by type, with a secondary discriminator on some variants (trigger_type for trigger, mode for delay, method for fetch, scope for throttle).
- API Invoke Trigger
- Segment Trigger
- Audience Trigger
- Webhook Trigger
- Send
- Delay for Duration
- Delay Until
- Fetch (GET/DELETE)
- Fetch (POST/PUT)
- AI
- Throttle (Static)
- Throttle (Dynamic)
- Batch
- Send to Digest
- Exit
- JourneyBranchNode
Cancelation token stored on the journey definition. It tags every run the journey creates so that POST /journeys/cancel can later cancel those runs by token. Accepts a templated string such as order-{{data.order_id}}, which is resolved per run when the journey is invoked. On a replace, omitting this field preserves any existing token and sending a value replaces it.
1"order-{{data.order_id}}"
Response
Journey created
A journey, with its current draft or published nodes and metadata.
A single node in a journey DAG. Discriminated by type, with a secondary discriminator on some variants (trigger_type for trigger, mode for delay, method for fetch, scope for throttle).
- API Invoke Trigger
- Segment Trigger
- Audience Trigger
- Webhook Trigger
- Send
- Delay for Duration
- Delay Until
- Fetch (GET/DELETE)
- Fetch (POST/PUT)
- AI
- Throttle (Static)
- Throttle (Dynamic)
- Batch
- Send to Digest
- Exit
- JourneyBranchNode