Skip to main content
POST
This endpoint is in alpha and is subject to change at any time. Email support for access.

Authorizations

Authorization
string
header
required

Accepts either a raw API key or Bearer <key>.

Headers

revision
string

Optional dated API revision for the request. Must use YYYY-MM-DD format.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-03-01"

Body

application/json

Create a draft journey. Send nodes and edges together to build the graph, or omit both to start from a graph of one enter node connected to one exit node.

name
string
required

Journey name. Trimmed before validation; must be non-blank.

Required string length: 1 - 255
trigger
object
required

The event that enters people into the journey.

nodes
object[]

The journey's nodes. A graph needs exactly one enter node, which has no incoming edges, and at least one exit node. Every node must be reachable from the enter node, and the graph must not contain cycles. Each branch and random_split arm must end in an exit or rejoin the other arm at the first node both arms reach. A random_split arm cannot contain a branch, an exit, or another random_split.

Maximum array length: 1000
edges
object[]

The journey's edges. A branch or random_split node has exactly two outgoing edges, with branch_index 0 and 1. An exit node has none, and every other node has exactly one.

Maximum array length: 2000

Response

Journey created.

A journey with its full graph — its trigger, nodes and edges. Messaging nodes expose message and content metadata but not content bodies or audience details.

id
integer
required
name
string
required

Journey name.

description
string | null
required

Optional journey description. May be null.

status
enum<string>
required

Journey lifecycle status.

Available options:
draft,
active,
paused,
archived,
cancelled
trigger
object | null
required

The event that enters people into the journey. null when none is set.

nodes
object[]
required
edges
object[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required