Sign in
workflow

Patch Workflow

patch/rest/workflows/{workflow_id_or_name}

Path parameters

workflow_id_or_namestring required

The ID or name of the workflow to update.

Request body

base_versioninteger nullable

The version number to base changes on. Defaults to the latest version.

commit_messagestring nullable

A message describing the changes.

nodesobject nullable

Node updates keyed by node name. Provide an object to add/update a node, or null to remove a node. Node configuration is deep-merged; dependencies are replaced.

required_input_variablesobject nullable

If provided, replaces the input variables entirely.

release_labelsstring[] nullable

Labels to move or attach to the newly created workflow version.

Response

Workflow version created successfully

successboolean required

Indicates if the request was successful.

workflow_idinteger required

The ID of the workflow.

workflow_namestring required

The name of the workflow.

workflow_version_idinteger required

The ID of the created workflow version.

version_numberinteger required

The version number.

base_versioninteger nullable

The base version this was created from (PATCH only).

release_labelsstring[] nullable

Labels attached to this version.

required_input_variablesobject

Required input variables for the workflow.

Changes