Skip to main content
PATCH
Update a journey

Authorizations

Authorization
string
header
required

Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.

Path Parameters

journeyId
integer | null

Numeric journey identifier.

Example:

33

Body

application/json

Update a journey’s name, description, tags, or status. Set status: "off" to pause; status: "live" to resume.

name
string
required
Minimum string length: 1
status
enum<string>
required

draft is a work-in-progress journey not yet active; live is currently accepting entries; off is paused — no new entrances are processed.

Available options:
draft,
live,
off
description
string | null
tags
string[] | null

Response

The updated journey.

A multi-step automation triggered by an event or a user’s entry into a target list.

id
integer
required

Numeric journey identifier.

Example:

33

project_id
integer
required
name
string
required
status
enum<string>
required

draft is a work-in-progress journey not yet active; live is currently accepting entries; off is paused — no new entrances are processed.

Available options:
draft,
live,
off
created_at
string | null
required
updated_at
string | null
required
description
string | null
tags
string[] | null
stats
object | null

Aggregated counts by step type. Cached; lags by a few seconds.

stats_at
string | null

Time stats were last refreshed.