• KB Home
  • API
  • API edna Chat Center
  • Причины перехода агента в неактивный статус
  • Обновить причину перехода агента в неактивный статус

Обновить причину перехода агента в неактивный статус

Используйте этот метод для того, чтобы обновить выбранную причину перехода агента в неактивный статус.

Разрешения

----
Permissions:INTEGRATOR
----

Пример curl

$ curl 'http://localhost:8080/api/v1/inactivity/reasons' -i -X PUT \
    -H 'Content-Type: application/json' \
    -d '{
  "system" : false,
  "code" : "123",
  "reasons" : [ {
    "locale" : "ru",
    "name" : "Обучение"
  } ],
  "color" : "#FFFFFF",
  "active" : true
}'

Пример HTTP запроса

PUT /api/v1/inactivity/reasons HTTP/1.1
Content-Type: application/json
Content-Length: 160
Host: localhost: 8080
{
    "system": false,
    "code": "123",
    "reasons": [
        {
            "locale": "ru",
            "name": "Обучение"
        }
    ],
    "color": "#FFFFFF",
    "active": true
}

Поля тела запроса

ПараметрТипОписание
codestringУникальный код причины. Ограничение длины — 256 символов.
reasons.localestringДвузначный языковой код причины
reasons.namestringПеревод причины на язык, указанный в reasons.locale. Ограничение длины — 50 символов.
color string (необязательно)Цвет причины в формате RGB, например, #FFFFFF или #ffffff
activeboolean (необязательно)Статус причины (активна, доступна на данный момент (true) или нет (false)). По умолчанию — true.

Примеры ответов

  • Успешный:
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
  • Пример ответа, возвращаемого, если причина, которую вы пытаетесь обновить, не существует:
HTTP/1.1 404 Not Found
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 148
{
    "method": "PUT",
    "uri": "/api/v1/inactivity/reasons",
    "code": null,
    "message": "InactivityReason with code \"123432 \" wasn't found"
}
  • Пример ответа, возвращаемый при попытке обновить причину, когда превышен лимит активных причин
HTTP/1.1 409 Conflict
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers