Skip to main content
PATCH
Update node

Authorizations

Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Path Parameters

journeyId
string
required

A draft journey id, or the initiative id (resolves to its current draft).

Minimum string length: 1
nodeId
string
required

Node id within the journey.

Minimum string length: 1

Body

application/json
name
string

New node label.

Minimum string length: 1
position
object
inputs
object

Config fields to merge into the node's inputs. The MERGED node must satisfy the same per-kind rules journeys_add_node enforces, so a field that contradicts what the node already stores is refused — sending templateId to a node whose mode is 'free_text', say. Being half-configured is never a refusal on its own.

Response

Success

id
string
required

Journey (workflow version) id.

initiativeId
string
required

The initiative this journey belongs to.

status
enum<string>
required

DRAFT (editable), PUBLISHED (live, frozen), or STOPPED (retired).

Available options:
DRAFT,
PUBLISHED,
STOPPED
version
integer
required

Version number within the initiative.

Required range: -9007199254740991 <= x <= 9007199254740991
definition
object
required

The full journey graph.