Hanzo
OpenapiFlow

Patches one of the caller's workflows: name, description, graph, or the locked…

Patches one of the caller's workflows: name, description, graph, or the locked flag — only the stated fields move.

PATCH /v1/flow/workflows/{workflow}

Addresshttps://api.hanzo.ai/v1/flow/workflows/{workflow}
MethodPATCH
Operationpatch_flow_workflows_by_workflow
AuthAuthorization: Bearer $HANZO_API_KEY

Patches one of the caller's workflows: name, description, graph, or the locked flag — only the stated fields move. Ownership is verified before the patch reaches the product.

Request

6 fields, body application/json (required).

FieldInTypeRequiredDescription
workflowpathstringyesWorkflow is the workflow's UUID, taken from the path.
databodyanyData replaces the workflow graph when present, verbatim.
descriptionbodystringDescription replaces the description when present.
lockedbodybooleanLocked freezes or unfreezes the workflow against edits when present.
namebodystringName renames the workflow when present.
workflowbodystringWorkflow is the workflow's UUID, taken from the path.

Response

StatusBodyMeaning
200ok

200 body — 1 field.

FieldInTypeAlwaysDescription
(body)bodyanyyes

Failure carries the platform error shape — see Errors.

Examples

hanzo flow workflows update <workflow>

Flow API · All Hanzo APIs · Interactive reference

How is this guide?

On this page