Skip to main content
POST
/
v1
/
labels
Create label
curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/labels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Production"
}
'
{
  "name": "Production",
  "verified": true,
  "homepage": true,
  "usage_count": 0
}

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

Query Parameters

​
userId
string

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

Body

application/json
​
name
string
required

Label name. Must be 2-25 characters.

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

Required string length: 2 - 25
​
verified
boolean
default:false

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

​
homepage
boolean
default:false

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

Response

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