Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Labels

Update label

Update an existing label, including renaming, changing Verified status, or adding/removing it from the Homepage.

Users can update basic labels they created. Organization Admin permissions are required to modify Verified or Homepage labels, including making a label verified or visible on the homepage.

put/v1/labels/{labelName}

Path parameters

namestring required

The name of the label to update. Lookup is case-insensitive.

URL-encode special characters.

Query parameters

userIdstring

Requires an Organization API key. Optional user ID that attributes the action to the specified user.

Request body

namestring

The new name of the label.

verifiedboolean

Organization Admin permissions required. If true, documents with the label will be marked as Verified.

homepageboolean

Organization Admin permissions required. If true, documents with the label will be visible on the Homepage.

colorstring

Hex color for the label

descriptionstring

Description of the label

Example request

{
  "color": "#0366d6",
  "description": "Documents based on dev schemas"
}

Response

Label updated successfully

namestring

The label name (2-25 characters).

Names are case-insensitive: "Production" and "production" are considered the same.

verifiedboolean

Whether the label is verified/curated

homepageboolean

Whether the label appears on the organization homepage

usage_countinteger

Total number of documents and folders using this label

colorstring

Hex color for the label

descriptionstring

Description of the label

Example response

{
  "name": "Production",
  "verified": true,
  "usage_count": 12,
  "color": "#0366d6",
  "description": "Documents based on dev schemas"
}