Skip to main content
PUT
Update Journey
Updates only the supplied fields. Send the complete replacement array when changing steps. Status changes also update holds on active enrollments. Declares the journeys.write scope. Authenticate with X-Api-Key; see Authentication. Authoring follows the API key requirements and retry rules. Restricted keys may submit an exact status-only stop body; adding any other field makes the request an authoring operation.

Path Parameters

string
required
Journey ID returned by create or list. Use a valid journey ID; malformed IDs currently return an unexpected error.

Body Parameters

string
New nonempty journey name.
object
Replacement trigger group. An empty value resets the trigger to an empty AND group.
integer
New routing priority.
array of objects
Complete replacement step array, using the same format as create.
string
New starting step. If omitted, the existing value is retained. A nonempty replacement steps array must still contain that existing start step.
string
draft, active, paused, or archived. Any other value is rejected. Clears the pause reason and updates enrollment holds.
Activation is checked against the result of the update, not the submitted fields: a journey that ends active must have a nonempty steps array and a start step contained in it. Update Journey Status applies the same checks to the stored journey.

Response

The journey object uses camelCase: id, integer accountId, name, trigger, priority, steps, startStepId, status, pauseReason, createdAt, and updatedAt. The trigger can be null. Each step contains stepId, name, stepType, config, and nullable nextStepId. Pause reasons and absent timestamps can be null.

Errors

Authoring may also return the policy, conflict, or availability errors documented under Create Journey.