USuseboom
Journeys

Update draft

Changed on

Replace a draft journey's whole graph. Journey-level metadata is merged, not replaced — keys the payload omits (e.g. the environment pin) keep their stored values. Only drafts can be edited; published versions are frozen (edit a live journey in the app to fork a new draft). Omit node positions and the server lays the graph out automatically.

patch/api/v1/journeys/{journeyId}

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).

Request body

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

  • 7c7a773b12ceRevision changes
    • breaking

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

    • 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 new optional request property ///

    • info

      added the new optional request property //

    • info

      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 // request property oneOf list

    • 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