Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Labels

Create label

Create a new label in the organization.

Any user can create basic labels, but Organization Admin permissions are required to:

  • Create Verified labels (verified: true)
  • Create Homepage labels (homepage: true)
post/v1/labels

Query parameters

userIdstring

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

Request body

namestring required

Label name. Must be 2-25 characters.

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

colorstring

Hex color for the label

descriptionstring

Description of the label

verifiedboolean

Requires Organization Admin permissions. If true, documents with this label will be marked as verified/curated.

homepageboolean

Requires Organization Admin permissions. If true, documents with this label will display on the instance's Homepage.

Example request

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

Response

Label created 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"
}