Documents

Label a document

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.

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

Path parameters

idstring uuid required

The document.

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Request body

addstring[]
removestring[]

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.