POpoll-the-people
Pages

Replace document labels.

Changed on

Assigns labels to a document for access control. The provided label IDs replace any existing labels on the document. To remove all labels (making the document accessible to everyone), send an empty array.

Notes: Maximum 50 labels per document.

Warning: This replaces all existing labels. Labels not included in the request will be removed from the document.

put/api/v1/projects/{projectId}/pages/{pageId}/labels

Request

Path parameters

projectIdinteger required

The unique identifier of the agent.

pageIdinteger required

The unique identifier of the page/document.

Request body

label_idsinteger[]

List of label IDs to set for this page (replaces existing labels)

Example request

{
  "label_ids": [
    1,
    2,
    3
  ]
}

Response

Replace labels attached to a page

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": [
    {
      "id": 1,
      "name": "Pricing"
    }
  ]
}

Changes