Skip to main content
PATCH
This endpoint is in alpha and is subject to change at any time.

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"

Path Parameters

id
integer
required

Journey ID.

Body

application/json

Update a journey's name and/or its trigger event. Omitted fields are left unchanged, and an empty body returns the journey unchanged. The journey's steps (nodes and edges) cannot be changed through this endpoint; any other field is rejected with 422 Validation error.

name
string

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

Required string length: 1 - 255
trigger
object

Replaces the event that enters people into the journey.

Response

Journey updated.

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