Update Priority
Update an existing Priority.
You are required to have the
manage-livechat-priorities permission.URL | Requires Auth | HTTP Method |
|---|---|---|
livechat/priorities/:priorityId | YES | PUT |
Argument | Example | Required | Description |
|---|---|---|---|
X-User-Id | myuser-name | Required | The authenticated ouser ID. |
X-Auth-Token | myauth-token | Required | Auth token. |
Argument | Example | Required | Description |
|---|---|---|---|
priorityId | 641daf3d7718f90c810429c8 | Required | The Id of the Priority to update. |
Argument | Example | Required | Description |
|---|---|---|---|
name | Very low | Optional | The name of the Priority. |
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"
}'
{
"success": true
}
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-prioritiespermission. - 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.
Authorization
No Permission
Unable to Update
Duplicate
{
"status": "error",
"message": "You must be logged in to do this."
}
{
"success": false,
"error": "error-not-authorized"
}
{
"success": false,
"error": "error-unable-to-update-priority"
}
{
"success": false,
"error": "error-duplicate-priority-name"
}
Version | Description |
|---|---|
6.0.0 | Added |
Last modified 2mo ago