Skip to main content
DELETE
/
v1
/
labels
/
{labelName}
Delete label
curl --request DELETE \
  --url https://{instance}.omniapp.co/api/v1/labels/{labelName} \
  --header 'Authorization: Bearer <token>'
{
  "error": "<response_code>",
  "message": "<error_reason>"
}
Labels that are currently applied to documents cannot be deleted. You must first remove the label from all documents.

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 delete. 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.

Response

Label deleted successfully. No response body.