remove-livechat-room-priority.md

Remove Livechat Room Priority

Remove the priority set to a Livechat room.

{% hint style="info" %} You are required to have the view-l-room permission. {% endhint %}

HTTP Method	URL	Requires Auth
DELETE	/api/v1/livechat/room/:rid/priority	yes

Path Variables

Key	Example Value	Description
rid*	tcbbSmWSLR5uo5PBW	The room ID.

Example Call

curl --location --request DELETE 'http://localhost:3000/api/v1/livechat/room/tcbbSmWSLR5uo5PBW/priority' \
--header 'X-Auth-Token: sMmROZpdpCTbY43XwPT_bCsWJc-VW7v_e2urWhUM766' \
--header 'X-User-Id: rYhzFRd2QZjNwAAXX'

Example Response

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.
• Error room: This error gets returned when no Room is found with the Id provided.

{% tabs %} {% tab title=" Authorization" %}

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

{% endtab %}

{% tab title="No Permission" %}

{
    "success": false,
    "error": "error-not-authorized"
}

{% endtab %}

{% tab title="Error room" %}

{
    "success": false,
    "error": "error-room-does-not-exist"
}

{% endtab %} {% endtabs %}

Change Log

Version	Description
6.0.0	Added