Links

Inquiry Prioritize

Sets the priority of an inquiry
An incoming chat, that has not yet been taken by the agent is called an 'inquiry'. After it's been taken by the agent it is referred to as 'room'.
URL
Requires Auth
HTTP Method
api/v1/livechat/inquiry.prioritize
YES
PUT

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)

Parameters

Argument
Example
Required
Description
roomId
Ey3RanxiR4wDCdWqy
Required
Inquiry
priority
4WcmeBE4spXx6AxrC
Required
Priority ID
roomID is actually inquiry. It the ID of the chat that's not been taken yet by the agent.

Example Call

curl --location --request PUT 'http://localhost:3000/api/v1/livechat/inquiry.prioritize'\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'
-d '{ "roomId": "Ey3RanxiR4wDCdWqy", "priority": "4WcmeBE4spXx6AxrC" }'

Result

{
"success": true
}
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.