---
title: "Label many documents at once"
method: POST
path: "/api/v1/rest/documents/labels/bulk"
tags: ["Documents"]
---

# Label many documents at once

`POST /api/v1/rest/documents/labels/bulk`

## Request

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

Adds and/or removes labels on up to 200 documents in one call — the selection bar’s «Etichette», for a job like «etichetta tutte le fatture di Bianchi»: find the documents with documents_search, then pass their ids here instead of calling documents_set_labels once per document. Name each label by its id (from documents_list_labels) or by its exact name; a name two labels share is refused with the candidates. Removal runs before addition, so a label in both lists ends up ON the documents. Refused whole — nothing changes — when one of the documents is in a class the caller may only read. An id that is not a document the caller can see is skipped, and the answer says how many were reached. The records themselves never change.

## Headers

- `X-Tenant-Id` string, uuid

## Request body

- object
  - `ids` string[], required: The documents, from documents_search.
  - `add` string[]: Labels to put on every one of them, by id or exact name.
  - `remove` string[]: Labels to take off every one of them, by id or exact name.

## 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.
- `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)