ONonesignal

Update journey node

Changed on

Apply a partial update to a single node, located by its server-assigned id, using JSON Merge Patch (RFC 7396). Send only the node fields you want to change; the rest of the node and the rest of the journey graph are left untouched, so in-flight users are preserved. Prefer this over re-sending the whole nodes array through Update journey, which replaces the graph wholesale. Returns the full updated journey.

patch/apps/{app_id}/journeys/{id}/nodes/{node_id}

Request

  • Base URL
    https://api.onesignal.com
  • URL
    https://api.onesignal.com/apps/{app_id}/journeys/{id}/nodes/{node_id}
  • Auth
    none required

Path parameters

app_idstring required

Your OneSignal App ID in UUID v4 format. See Keys & IDs.

idstring required

UUID of the journey that owns the node.

node_idstring required

Server-assigned UUID of the node to update, from a prior View journey fetch.

Headers

Authorizationstring required

Your App API key with prefix Key . See Keys & IDs.

Content-Typestring required

Request body

concurrency_keystring nullable

Optional optimistic-concurrency token. Pass the concurrency_key from a prior fetch to reject the update with 409 if the journey changed in the meantime. Omit to skip the check. It is not merged onto the node.

Response

200

idstring

Journey UUID. Read-only.

app_idstring

UUID of the app the journey belongs to. Read-only.

namestring

Journey name, up to 300 characters.

descriptionstring nullable

Journey description, up to 1024 characters. Defaults to an empty string.

state'draft' | 'scheduled' | 'processing' | 'active' | 'archived'

Journey state. Read-only. New journeys are created as draft. processing is a transient state while an activation is in progress, and archived is a journey that has been stopped. Change it through the state field on Update journey.

created_atstring

ISO 8601 creation time. Read-only.

updated_atstring

ISO 8601 last-update time. Read-only.

started_atstring nullable

ISO 8601 time the journey was activated, or null. Read-only. May stay null briefly after you set state to active: activation is enqueued for processing, and started_at populates once the journey finishes processing and becomes active.

archived_atstring nullable

ISO 8601 time the journey was archived, or null. Read-only.

created_sourcestring nullable

Origin of the journey, for example public_api or dashboard. Read-only.

concurrency_keystring

Opaque optimistic-concurrency token. Read-only. Pass it back on update to guard against overwriting a concurrent change (409 journey-stale). Send it back exactly as read from this response; do not construct or parse it.

Changes