Authentication & scope
Requiresworkflows-write and workspace admin access. The version must belong to the requested workflow and workspace.
Request
change_notes is required in the payload and supports up to 20,000 characters. Human/ordinary API requests may send null to clear it; Workflow Builder must provide a non-empty justification. Execution fields such as definition, metadata and state are prohibited.
Response
200 returns the version with its corrected notes. The definition, version number and publication remain unchanged, including for locked versions. The previous and new notes are recorded in the workflow audit log. Concurrent corrections use the last saved value.
422 reports invalid notes, missing payload fields or a debug version. 403 means insufficient permissions. 404 means a workspace/workflow/version mismatch.