Get a Priority

Prev Next
Get
/api/v1/livechat/priorities/{priorityId}
Premium tag

Get details of a specific priority. At least one of the following permissions is required:

  • manage-livechat-priorities
  • view-l-room

Changelog

Version Description
6.0.0 Added
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
priorityId
stringRequired

The priority ID.

Responses
200

OK

Success Example
{
  "_id": "64007cc2fa0ed7dd905092e3",
  "i18n": "Lowest",
  "sortItem": 5,
  "dirty": false,
  "success": true
}
object
_id
string
i18n
string
sortItem
integer
dirty
boolean
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
Tags