Edit — or retire — one item of the brand blueprint
Edits a single item of the brand blueprint by id and saves it as a NEW VERSION, answering the whole blueprint after the edit.
PATCH /v1/guide/blueprint/{collection}/{id}
| Address | https://api.hanzo.ai/v1/guide/blueprint/{collection}/{id} |
| Method | PATCH |
| Operation | patch_guide_blueprint_by_collection_by_id |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Edits a single item of the brand blueprint by id and saves it as a NEW VERSION, answering the whole blueprint after the edit. collection is one of sections, steps, strategies or templates; anything else is 400, and an id that collection does not hold is 404. This is also the retire lever: {"enabled": false} takes an item out of every org's journey without deleting it or its history.
SuperAdmin ONLY, like the rest of the authoring plane; a per-org admin is 403. The write is audited.
The patch is a SHALLOW merge over the item's own top-level keys — a key you send replaces that key whole, a key you omit is left alone — and id is dropped from the patch before it is applied, so an edit can never rekey an item. That is why the body has no declarable shape: its keys are the patched item's, not this route's.
Fail-closed on the WHOLE document, not just the item: the blueprint is re-validated after the merge, so a patch that would dangle a dependency, break the step DAG or empty the journey is 422 and nothing is saved. An empty patch is 400 and one over 16 MiB is 413.
Request
2 fields.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
collection | path | string | yes | |
id | path | string | yes |
Response
The document declares no response body for this operation. It answers 200 on success and the platform error shape on failure — see Errors.
Examples
hanzo guide blueprint collection update <collection> <id>import { Configuration, GuideApi } from 'hanzoai';
const api = new GuideApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.patchGuideBlueprintByCollectionById({ collection: 'collection', id: 'id' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import GuideApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = GuideApi(client).patch_guide_blueprint_by_collection_by_id(collection='collection', id='id')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.GuideAPI.PatchGuideBlueprintByCollectionById(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, guide_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = guide_api::patch_guide_blueprint_by_collection_by_id(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.GuideApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new GuideApi(client).patchGuideBlueprintByCollectionById();curl -X PATCH https://api.hanzo.ai/v1/guide/blueprint/<collection>/<id> \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches guide through the guide tool, which names its 19 operations with its own verbs — this one among them, under a name only the door 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_guide"
}
}
}'How is this guide?