Update Priority

Update an existing priority.

You are required to have the manage-livechat-priorities permission.

HTTP MethodURLRequires Auth

PUT

/api/v1/livechat/priorities/:priorityId

Path Variables

KeyExample ValueDescription

priorityId*

641daf3d7718f90c810429c8

The ID of the priority to update.

Body Parameters

KeyExample ValueDescription

name*

Very low

The name of the priority.

Example Call

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"
}'

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.

{
    "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.