Tags

Update a tag name.

Changed on

Updates the name of an existing tag. User and document assignments are preserved.

Tags are called labels in the API, so paths and fields use label (for example labelId and labels).

put/api/v1/projects/{projectId}/labels/{labelId}

Request

Path parameters

projectIdinteger required

The unique identifier of the agent.

labelIdinteger required

The unique identifier of the tag to operate on.

Request body

namestring

New tag name (must not start with a digit)

Example request

{
  "name": "Pricing"
}

Response

Rename a tag within a project

status'error' | 'success'

The status of the response

Example response

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

Changes