Get a Tag

Prev Next
Get
/api/v1/livechat/tags/{tagId}
Premium tag

At least one of the following permissions is required:

  • view-l-room
  • manage-livechat-tags
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Path parameters
tagId
stringRequired

The tag ID.

ExamplepXkCRLGxD34y2FEZq
Responses
200

OK

Success Example
{
  "_id": "nNJntq2n6GBdR8JC4",
  "name": "331",
  "numDepartments": 2,
  "departments": [
    "kxL4qaa29SMpy3ZXG",
    "WRY3EFGAT9Xh5NFBv"
  ],
  "_updatedAt": "2022-11-28T07:17:31.973Z",
  "description": "test",
  "success": true
}
object
_id
string
name
string
numDepartments
integer
departments
Array of string
string
_updatedAt
string
description
string
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
403

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
Unauthorized
{
  "success": false,
  "error": "unauthorized"
}
object
success
boolean
error
string
404

Not Found

Example 1
{
  "success": false,
  "error": "Tag not found"
}
object
success
boolean
error
string
Tags