Skip to main content
PUT
/
v1
/
labels
/
{labelName}
curl -X PUT "https://{instance}.omniapp.co/api/v1/labels/Draft" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Ready for Review"}'
{
  "name": "Ready for Review",
  "verified": true,
  "homepage": false,
  "usage_count": 3
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
name
string
required

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

URL-encode special characters.

Query Parameters

​
userId
string

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

Body

application/json

Only include the fields you want to update when submitting requests.

​
name
string

The new name of the label.

Required string length: 2 - 25
​
verified
boolean

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

​
homepage
boolean

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

Response

Label updated successfully

A label for organizing and categorizing documents and folders

​
name
string

The label name (2-25 characters).

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

Example:

"Production"

​
verified
boolean

Whether the label is verified/curated

Example:

true

​
homepage
boolean

Whether the label appears on the organization homepage

Example:

false

​
usage_count
integer

Total number of documents and folders using this label

Example:

12