Skip to content

Latest commit

 

History

History
66 lines (48 loc) · 1.85 KB

File metadata and controls

66 lines (48 loc) · 1.85 KB

Reset Priorities

This resets all Priorities back to default.

{% hint style="info" %} You are required to have the manage-livechat-priorities permission. {% endhint %}

URLRequires AuthHTTP Method
api/v1/livechat/priorities.resetYESPOST

Headers

ArgumentExampleRequiredDescription
X-User-Idmyuser-nameRequiredThe authenticated ouser ID.
X-Auth-Tokenmyauth-tokenRequiredAuth token.

Example Call

curl --location --request POST 'http://localhost:3000/api/v1/livechat/priorities.reset' \
--header 'X-Auth-Token: sMmROZpdpCTbY43XwPT_bCsWJc-VW7v_e2urWhUM766' \
--header 'X-User-Id: rYhzFRd2QZjNwAAXX'

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 manage-livechat-priorities permission.

{% 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 %} {% endtabs %}

Change Log

Version Description
6.0.0 Added