OMomni
Document labels

Apply label to document

Apply an existing label to a document. Labels must be created first via the Create label endpoint.

Documents can have multiple labels. When a new label is applied using this endpoint, the API adds it to the document's existing labels. Labels are not replaced.

put/v1/documents/{documentId}/labels/{labelName}

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/documents/{documentId}/labels/{labelName}
  • Auth
    HTTP bearer

Path parameters

documentIdstring required

The document identifier

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

Query parameters

userIdstring

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.

Changes

No recorded changes to this operation across all 2 revisions of this API.