Cancel framework

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

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

Framework → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/framework/{doctype}/{name}/cancel`
Method	`POST`
Operation	`post_framework_by_doctype_by_name_cancel`
Auth	`Authorization: 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.

Field	In	Type	Required	Description
`doctype`	path	string	yes	DocType is the document's DocType, by ADDRESS — "module.name", from the path.
`name`	path	string	yes	Name is the document's name — its key within the DocType — from the path.

Response

Status	Body	Meaning
`200`	object	ok
`default`	problem-details	refused

200 body — 1 field.

Field	In	Type	Always	Description
`*`	body	any	—

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo framework doctype cancel <doctype> <name>

.ts

.py

.go

.rs

.java

import { Configuration, FrameworkApi } from 'hanzoai';

const api = new FrameworkApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postFrameworkByDoctypeByNameCancel({ doctype: 'doctype', name: 'name' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import FrameworkApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = FrameworkApi(client).post_framework_by_doctype_by_name_cancel(doctype='doctype', name='name')

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.FrameworkAPI.PostFrameworkByDoctypeByNameCancel(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, framework_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = framework_api::post_framework_by_doctype_by_name_cancel(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.FrameworkApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new FrameworkApi(client).postFrameworkByDoctypeByNameCancel();

curl -X POST https://api.hanzo.ai/v1/framework/<doctype>/<name>/cancel \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches framework through the framework tool, which names its 14 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "get_framework_by_doctype"
         }
       }
     }'

Framework API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList summary NextCreate submit