Skip to main content
PUT
/
v1
/
documents
/
{documentId}
/
labels
/
{labelName}
Apply label to document
curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/documents/{documentId}/labels/{labelName} \
  --header 'Authorization: Bearer <token>'
{
  "error": "<response_code>",
  "message": "<error_reason>"
}

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

​
documentId
string
required

The document identifier

​
labelName
string
required

The label name to apply:

  • Must be 2-25 characters
  • Labels are case insensitive. For example, adding BlobSales when blobsales exists will be treated as a duplicate.
  • Special characters must be URL-encoded (e.g., Q1%202024 for "Q1 2024").

Additionally, adding Verified or Homepage labels require Organization Admin permissions.

Required string length: 2 - 25

Query Parameters

​
userId
string

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

Response

Label applied successfully. No response body.

This response is returned whether the label was newly applied or already existed on the document.