Hanzo
OpenapiFramework

Moves a submitted document to cancelled (docstatus 1 → 2) after its on_cancel…

Moves a submitted document to cancelled (docstatus 1 → 2) after its on_cancel hooks agree.

POST /v1/framework/{doctype}/{name}/cancel

Addresshttps://api.hanzo.ai/v1/framework/{doctype}/{name}/cancel
MethodPOST
Operationpost_framework_by_doctype_by_name_cancel
AuthAuthorization: Bearer $HANZO_API_KEY

Moves a submitted document to cancelled (docstatus 1 → 2) after its on_cancel hooks agree. Cancelling is terminal — a cancelled document cannot be re-submitted — but it CAN then be deleted.

Request

2 fields.

FieldInTypeRequiredDescription
doctypepathstringyesDocType is the document's DocType, from the path.
namepathstringyesName is the document's name — its key within the DocType — from the path.

Response

StatusBodyMeaning
200objectok

200 body — 1 field.

FieldInTypeAlwaysDescription
*bodyobject

Failure carries the platform error shape — see Errors.

Examples

hanzo framework doctype cancel <doctype> <name>

Framework API · All Hanzo APIs · Interactive reference

How is this guide?

On this page