Update docs

Renames a document or moves it — under another document, to the top of its teamspace, or to another teamspace with everything nested under it.

PATCH /v1/team/docs/{id}

Team → · All API references → · Get started →


Address	`https://api.hanzo.ai/v1/team/docs/{id}`
Method	`PATCH`
Operation	`patch_team_docs_by_id`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Renames a document or moves it — under another document, to the top of its teamspace, or to another teamspace with everything nested under it.

Anyone who can write the teamspace may rename or move a page, as in the Team client. A move goes after its new siblings, and a document cannot be moved under itself or under one of its own descendants.

Request

6 fields, body application/json (required).

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the document, from the path.
`id`	body	string	—	ID is the document, from the path.
`parent`	body	string	—	Parent moves the document under another one; "" moves it to the top of its teamspace.
`space`	body	string	—	Space is the space uuid holding it.
`teamspace`	body	string	—	Teamspace moves the document — with everything nested under it — to another teamspace, at the top unless Parent names a document there.
`title`	body	string	—	Title renames the document.

Response

Status	Body	Meaning
`200`	team.teamDoc	ok
`default`	problem-details	refused

200 body — 11 fields.

Field	In	Type	Always	Description
`author`	body	string	—	Author is the account uuid that created it.
`collaborator`	body	string	—	Collaborator is the documentId to open the body with on the /v1/team/collaborator Y.js socket: "<space>\|document:class:Document\|<id>\|content".
`comments`	body	integer (int64)	—	Comments is how many comments it has.
`createdOn`	body	integer (int64)	—	CreatedOn is when it was created, unix milliseconds.
`id`	body	string	—	ID is the document's own id.
`modifiedOn`	body	integer (int64)	—	ModifiedOn is when its title or place last changed, unix milliseconds.
`parent`	body	string	—	Parent is the document this one is nested under.
`rank`	body	string	—	Rank orders siblings: compare as plain strings, ascending.
`space`	body	string	—	Space is the space uuid holding it.
`teamspace`	body	string	—	Teamspace is the teamspace it belongs to.
`title`	body	string	—	Title is the document's title.

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.

import { Configuration, TeamApi } from 'hanzoai';

const api = new TeamApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.patchTeamDocsById({ id: 'id', id: "<id>", parent: "<parent>" });

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = TeamApi(client).patch_team_docs_by_id(id='id', id="<id>", parent="<parent>")

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

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

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

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

let result = team_api::patch_team_docs_by_id(&cfg, Default::default()).await?;

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

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

var result = new TeamApi(client).patchTeamDocsById();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl -X PATCH https://api.hanzo.ai/v1/team/docs/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "id": "<id>",
       "parent": "<parent>"
     }'

MCP reaches team through the team tool, which names its 18 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_collaborator"
         }
       }
     }'

Team API · All Hanzo APIs · Interactive reference

Request

Response

Examples

On this page