Tags

Assign users to a tag.

Changed on

Sets which users are assigned to each tag. The provided user list becomes the source of truth - users not included in the list are removed from that tag, and new users are added.

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

Notes: Requires Custom plan.

Warning: This is a replacement operation, not an append. Users not included in the request will be removed from the tag.

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

Request

Path parameters

projectIdinteger required

The unique identifier of the agent. You can find this in the CustomGPT dashboard or from the response of POST /api/v1/projects.

Request body

Example request

{
  "labels": [
    {
      "id": 1,
      "users": [
        "manager@example.com"
      ]
    }
  ]
}

Response

Update tags and assigned users for a project

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 1,
        "name": "German",
        "users": [
          "manager@example.com"
        ]
      }
    ],
    "first_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
    "next_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
    "path": "https://app.customgpt.ai/api/v1/users?page=1",
    "per_page": 10,
    "prev_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
    "to": 1,
    "total": 1
  }
}

Changes