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 |
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) |
Argument | Example | Required | Description |
---|---|---|---|
priorityId | 64007cc2fa0ed7dd905092e3 | Required | Priority ID |
curl --location 'http://localhost:3000/api/v1/livechat/priorities/64007cc2fa0ed7dd905092e3' \
--header 'X-Auth-Token: sMmROZpdpCTbY43XwPT_bCsWJc-VW7v_e2urWhUM766' \
--header 'X-User-Id: rYhzFRd2QZjNwAAXX'
{
"_id": "64007cc2fa0ed7dd905092e3",
"i18n": "Lowest",
"sortItem": 5,
"dirty": false,
"success": true
}
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
orview-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"
}
Version | Description |
---|---|
6.0.0 | Added |
Last modified 2mo ago