---
title: "Label a document"
method: PATCH
path: "/api/v1/rest/documents/{id}/labels"
tags: ["Documents"]
---

# Label a document

`PATCH /api/v1/rest/documents/{id}/labels`

## Request

- Base URL: `https://api.custodo.ai`
- URL: `https://api.custodo.ai/api/v1/rest/documents/{id}/labels`
- Auth: HTTP bearer

Adds and/or removes labels on one document — the record itself is never changed, so this is allowed on a document whose versions are sealed. Name each label by its id (from documents_list_labels) or by its exact name; a name that two labels share (the same «2026» under two parents) is refused with the candidates, so pass the id then. Labels must already exist — documents_create_label makes one. Answers with the document’s labels as they now stand.

## Path parameters

- `id` string, uuid, required

## Headers

- `X-Tenant-Id` string, uuid

## Request body

- object
  - `add` string[]
  - `remove` string[]

## Response `200`

Done. `data` is the tool’s own answer.

- RestResult
  - `ok` true, required
  - `data` unknown, required

## Other responses

- `400`: The arguments did not validate: `error.message` names the field, what it expects and what arrived.
- `401`: No API key, or one that is malformed, unknown, revoked or expired.
- `403`: The call never ran: the module is off for this organisation, the credential lacks the permission or the module, the tier does not cover it, or the tool is destructive and the key was not minted for that.
- `404`: Nothing with that id in this organisation.
- `409`: The record is in a state that does not allow it — under legal hold, already sent, already closed. `error.code` says which.
- `422`: The tool ran and refused, in a sentence of its own (`TOOL_REFUSED`): the message says what to change. Retrying the same call will not help.
- `429`: The API key has spent its minute, or its day. Every request a key makes counts. See `Retry-After`.

---

[API](https://skmtc.dev/custodo/apis/custodo-integrazioni.md) · [All operations](https://skmtc.dev/custodo/apis/custodo-integrazioni/llms.txt) · [OpenAPI document](https://skmtc.dev/custodo/apis/custodo-integrazioni/revisions/16d336d3ec2a?raw)