Set Livechat Room Priority

Set the priority of a Livechat room.

You are required to have the view-l-room permission.

HTTP MethodURLRequires Auth

POST

/api/v1/livechat/room/:rid/priority

Path Variables

KeyExample ValueDescription

rid*

tcbbSmWSLR5uo5PBW

The room ID.

Body

KeyExample ValueDescription

priorityId*

64007cc2fa0ed7dd905092e6

The ID of the priority to set.

Example Call

curl --location 'http://localhost:3000/api/v1/livechat/room/tcbbSmWSLR5uo5PBW/priority' \
--header 'X-Auth-Token: sMmROZpdpCTbY43XwPT_bCsWJc-VW7v_e2urWhUM766' \
--header 'X-User-Id: rYhzFRd2QZjNwAAXX' \
--header 'Content-Type: application/json' \
--data '{
    "priorityId": "64007cc2fa0ed7dd905092e6"
}'

Example Result

Success

{
    "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 view-l-room permission.

  • Invalid Parameter: Gets returned when no priority Id is sent in the body.

  • Invalid priority: This error gets returned when no Priority is found with the Id provided.

{
    "status": "error",
    "message": "You must be logged in to do this."
}

Change Log

VersionDescription

6.0.0

Added

Last updated

Rocket.Chat versions receive support for six months after release.