Hanzo
OpenapiAuto

Updates one automation's metadata in place.

Updates one automation's metadata in place. Every field is optional; a field the request omits is left alone.

PATCH /v1/auto/flows/{id}

Addresshttps://api.hanzo.ai/v1/auto/flows/{id}
MethodPATCH
Operationpatch_auto_flows_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Updates one automation's metadata in place. Every field is optional; a field the request omits is left alone. Publishing a version pins which one runs, and is refused unless that version belongs to this flow.

Request

6 fields, body application/json (required).

FieldInTypeRequiredDescription
idpathstringyesID is the flow to update, from the path.
externalIdbodystringExternalID sets the caller's own id for this flow.
folderIdbodystringFolderID moves the flow in the builder's tree.
idbodystringID is the flow to update, from the path.
metadatabodyanyMetadata replaces the caller's opaque JSON.
publishedVersionIdbodystringPublishedVersionID pins the version runs execute.

Response

StatusBodyMeaning
200Flowok

200 body — 9 fields.

FieldInTypeAlwaysDescription
createdbodyinteger
externalIdbodystring
folderIdbodystring
idbodystring
metadatabodyany
projectIdbodystringprojectId == org (server-derived)
publishedVersionIdbodystring
statusbodystring
updatedbodyinteger

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Auto API · All Hanzo APIs · Interactive reference

How is this guide?

On this page