Links

Get a Priority

Get the details of a priority
You are required to have the manage-livechat-priorities or view-l-room permission.
URL
Requires Auth
HTTP Method
livechat/priorities/:priorityId
YES
GET

Headers

Argument
Example
Required
Description
X-User-Id
myuser-name
Required
Your username hash (returned after you log in through the API)
X-Auth-Token
myauth-token
Required
Your token (returned after you log in through the API)

Path Variables

Argument
Example
Required
Description
priorityId
64007cc2fa0ed7dd905092e3
Required
Priority ID

Example Call

curl --location 'http://localhost:3000/api/v1/livechat/priorities/64007cc2fa0ed7dd905092e3' \
--header 'X-Auth-Token: sMmROZpdpCTbY43XwPT_bCsWJc-VW7v_e2urWhUM766' \
--header 'X-User-Id: rYhzFRd2QZjNwAAXX'

Result

{
"_id": "64007cc2fa0ed7dd905092e3",
"i18n": "Lowest",
"sortItem": 5,
"dirty": false,
"success": true
}

Error

Any of the following errors can occur on the endpoint.
  • Authorization: Requires an authentication token for the request to be made.
  • No Permission: This occurs when the authenticated user doesn't have manage-livechat-priorities or view-l-room permission.
  • Not Found: This error gets returned when no Priority is found with the Id provided.
Authorization
No Permission
Not Found
{
"status": "error",
"message": "You must be logged in to do this."
}
{
"success": false,
"error": "error-not-authorized"
}
{
"success": false,
"error": "Priority with id :priorityId not found"
}

Change Log

Version
Description
6.0.0
Added
Last modified 2mo ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.