Sign in

v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB
Labels

Update a label

put/api/v1/labels/{name}

Path parameters

namestring required

Label name

Example:verified

Label name

Query parameters

userIdstring uuid

Target user membership ID (for org-scoped API keys)

Target user membership ID (for org-scoped API keys)

Request body

colorstring nullable

Hex color for the label (e.g. #0366d6)

descriptionstring nullable

Label description

homepageboolean

Show label on homepage. Requires admin permissions to modify.

namestring

Label name

verifiedboolean

Mark as verified label. Requires admin permissions to modify.

Example request

{
  "color": "#0366d6",
  "description": "Important items that need attention",
  "name": "important"
}

Response

Label updated successfully

colorstring nullable required

Hex color for the label (e.g. #0366d6)

descriptionstring nullable required

Label description

homepageboolean required

Whether label is shown on homepage

namestring required

Label name

usage_countnumber required

Number of documents with this label

verifiedboolean required

Whether label is verified

Example response

{
  "color": "#0366d6",
  "description": "Important items that need attention",
  "name": "verified"
}