update-priority.md

Update Priority

Update an existing priority.

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

HTTP Method	URL	Requires Auth
PUT	/api/v1/livechat/priorities/:priorityId	yes

Path Variables

Key	Example Value	Description
priorityId*	641daf3d7718f90c810429c8	The ID of the priority to update.

Body Parameters

Key	Example Value	Description
name*	Very low	The name of the priority.

Example Call

{% code overflow="wrap" %}

curl --location --request PUT 'http://localhost:3000/api/v1/livechat/priorities/64007cc2fa0ed7dd905092e3' \
--header 'X-Auth-Token: sMmROZpdpCTbY43XwPT_bCsWJc-VW7v_e2urWhUM766' \
--header 'X-User-Id: rYhzFRd2QZjNwAAXX' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Very low"
}'

{% endcode %}

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 manage-livechat-priorities permission.
• Unable to Update: This error gets returned when no Priority is found with the Id provided.
• Duplicate: Occurs when the priority to be updated will cause a duplicate.

{% 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="Unable to Update" %}

{
    "success": false,
    "error": "error-unable-to-update-priority"
}

{% endtab %}

{% tab title="Duplicate" %}

{
    "success": false,
    "error": "error-duplicate-priority-name"
}

{% endtab %} {% endtabs %}

Change Log

Version	Description
6.0.0	Added