Documents

Rename, recolour or move a label

Changes a label’s name, colour or place in the tree. Pass parent_id: null to move it to the top level; omit parent_id entirely to leave it where it is. Refuses to nest a label under itself or under one of its own descendants (DOCUMENT_LABEL_CYCLE), deeper than three levels, or with a name a sibling already has.

patch/api/v1/rest/documents/labels/{id}

Request

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

Path parameters

idstring uuid required

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

namestring
color'slate' | 'red' | 'amber' | 'green' | 'teal' | 'blue' | 'violet' | 'pink'
parent_idstring uuid nullable

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.