v1

latestOpenAPI 3.0.02026-07-26870415.2 KB

workflows

Update workflow

Replaces a workflow definition by creating a new version under the same workflow (the old version is untouched). New version is DRAFT unless activate is true. Config fields whose value is the redaction placeholder are preserved from the current version.

put/v1/workflows/{id}

Path parameters

idstring required

Workflow (version) identifier.

Example:k17demo8f8x7c9v0n2q4r6t8y1u3i5o

Request body

workspace_idstring

Optional workspace override. Omit to resolve the workflow's workspace automatically.

namestring required

Workflow name

descriptionstring nullable

colorstring

Hex color for the workflow, e.g. #2563eb

first_step_idstring nullable

Id of the entry step, or null.

activateboolean

When true, the version goes live (status ACTIVE). Defaults to false (DRAFT).

Response

Updated workflow definition (new version)