v16

latestOpenAPI 3.1.1raw.githubusercontent.com2026-08-0124102197.4 KB
V3 Workflows

Update a workflow

Updates human-facing workflow metadata and/or the workflow definition. Status changes are handled by lifecycle endpoints (enable, disable, archive, unarchive) so the state machine remains explicit. Provided fields replace the corresponding stored fields; this endpoint does not implement JSON Patch.

name and description can be updated in any state except archived. The definition can only be updated while the workflow is draft or disabled: the live version of an enabled workflow is an immutable snapshot, so definition changes require disabling (or moving to draft) first and re-enabling afterwards. Violations return 422 with code invalid_workflow_state. A structurally invalid definition returns 400 with structured invalid_params; the referenced survey and ending cards are not verified here — that existence check runs when the workflow is enabled.

patch/api/v3/workflows/{workflowId}

Path parameters

workflowIdstring cuid2 required

Workflow identifier.

Request body

namestring
descriptionstring nullable

Response

Workflow updated successfully