Skip to main content
DELETE
/
v1
/
documents
/
{documentId}
/
labels
/
{labelName}
Remove label from document
curl --request DELETE \
  --url https://{instance}.omniapp.co/api/v1/documents/{documentId}/labels/{labelName} \
  --header 'Authorization: Bearer <token>'
{
  "error": "<response_code>",
  "message": "<error_reason>"
}
Remove a label from a document.
This endpoint is not idempotent. If the label does not exist on the document, the API returns a 404 error.

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 remove:

  • Must be 2-25 characters
  • Labels are case insensitive. For example, removing BlobSales will remove blobsales if it exists on the document.
  • Special characters must be URL-encoded (e.g., Q1%202024 for "Q1 2024").
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 removed successfully. No response body.