# Update docs

URL: https://docs.hanzo.ai/docs/openapi/team/patch-team-docs-by-id

> 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 →](https://docs.hanzo.ai/docs/openapi/team) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                          |
| ------------- | ---------------------------------------- |
| **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](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

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

**SDK**

**.ts**

```ts
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>" });
```

**.py**

```python
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>")
```

**.go**

```go
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
}
```

**.rs**

```rust
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?;
```

**.java**

```java
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();
```

**HTTP**

```bash
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**

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

```bash
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": "list_team_account_providers"
         }
       }
     }'
```

---

[Team API](https://docs.hanzo.ai/docs/openapi/team) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)