Journeys

Update one node's name, position, and/or config (inputs shallow-merge). Use journeys_authoring_catalog for a node kind's input fields.

patch/api/v1/journeys/{journeyId}/nodes/{nodeId}

Request

  • Base URL
    https://www.useboom.ai
  • Auth
    HTTP bearer

Path parameters

journeyIdstring required

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

nodeIdstring required

Node id within the journey.

Request body

namestring

New node label.

inputsobject

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

idstring required

Journey (workflow version) id.

initiativeIdstring required

The initiative this journey belongs to.

status'DRAFT' | 'PUBLISHED' | 'STOPPED' required

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

versioninteger required

Version number within the initiative.

Changes

    • breaking

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #10 subschema #13 subschema #14 subschema #15 subschema #16 subschema #17 subschema #18 subschema #19 subschema #20 subschema #21 subschema #22 subschema #23 to the // response property oneOf list for the response status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed subschema #1 subschema #2 subschema #5 subschema #8 subschema #9 subschema #10 subschema #11 from the // response property oneOf list for the response status