hints.config.update

Scope: hints

Кто может вызывать: право группы W. В отличие от остальных методов, hints.config.update работает и при выключенном модуле (switchOn=N), иначе через REST нельзя снова включить модуль. Подробнее: Права доступа

Обновляет настройки модуля для сайта. Передаются только изменяемые поля; ответ — актуальная конфигурация сайта (как hints.config.get с siteId).

HTTP: POST

Побочные эффекты: при изменении switchOn, moderateOn или theme сбрасывается кэш рендера подсказок для сайта (HintsRenderCache::invalidateSite).

Поле theme принимает только light или dark (см. hints.config.theme.list). Без siteId используется текущий сайт контекста запроса.

Параметры метода

Параметр Тип Обяз. Описание
siteId string нет ID сайта; по умолчанию — текущий сайт
switchOn bool нет Включить/выключить модуль на сайте
moderateOn bool нет Режим модерации
theme string нет Тема: light или dark

Возвращаемые данные

result.result — объект конфигурации сайта.

Поле Тип Описание
siteId string ID сайта
name string Название сайта
switchOn bool Модуль включён
moderateOn bool Режим модерации
theme string Тема (light / dark)

Обработка ошибок

Справочник кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
PERMISSION_DENIED Нет права записи (W)
VALIDATION_ERROR Недопустимое значение theme (только light или dark)
NOT_FOUND Сайт с указанным siteId не найден или неактивен
INTERNAL_ERROR Внутренняя ошибка сервера

Пример запроса (POST)

curl -X POST "https://76592.dev.wehive.digital/rest/1/{webhook_code}/hints.config.update.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          --data '{
          "siteId": "s1",
          "switchOn": true,
          "theme": "light"
        }'

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

Форма ответа совпадает с hints.config.get для одного сайта:

{
          "result": {
            "result": {
              "siteId": "s1",
              "name": "Моя компания",
              "switchOn": true,
              "moderateOn": false,
              "theme": "light"
            },
            "error": null
          },
          "time": {
            "start": 1788357574,
            "finish": 1788357574.970185,
            "duration": 0.9701850414276123,
            "processing": 0,
            "date_start": "2026-09-02T16:59:34+03:00",
            "date_finish": "2026-09-02T16:59:34+03:00"
          }
        }

См. также

Предыдущая
hints.config.get
Следующая
hints.config.theme.list