hints.hint.update

Scope: hints

Кто может вызывать: RestAccess::requireWrite(). Подробнее: Права доступа

Обновляет подсказку. Семантика PATCH: переданные поля накладываются на текущие значения; непереданные поля сохраняются.

HTTP: POST

Побочные эффекты: обновляет элемент инфоблока.

Параметр id обязателен (alias: hintId). Набор полей — как в hints.hint.add; все опциональны кроме id. Валидация (name, detailText, code при showByAnchor) применяется к результирующему merged-состоянию.

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

Параметр Тип Обяз. Описание
id int да ID подсказки (alias: hintId)
name string нет Название
detailText string нет HTML-содержимое
pageId int нет ID страницы (alias: sectionId)
selector string нет CSS-селектор
code string нет Код якоря
active bool нет Активность
sort int нет Сортировка
form string нет xmlId формы
event string нет xmlId события
hideNext string|bool нет Скрыть «Далее»
hideSkip string|bool нет Скрыть «Пропустить»
showByAnchor string|bool нет Показ по якорю
showByQueue string|bool нет Показ по очереди
radius string|int нет Радиус
timeout string|int нет Таймаут
nextText string нет Текст «Далее»
linkForNextBtn string нет Ссылка «Далее»

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

result.result — обновлённая подсказка (поля как у hints.hint.get).

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
MODULE_DISABLED Модуль выключен на сайте
PERMISSION_DENIED Нет права записи (W)
VALIDATION_ERROR Не указан или некорректный id; pageId сброшен в 0; неизвестный xmlId в form/event; ошибки валидации merged-состояния
HINT_NOT_FOUND Подсказка не найдена
PAGE_NOT_FOUND Указанный pageId не найден
INTERNAL_ERROR Внутренняя ошибка сервера

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

curl -X POST "https://76592.dev.wehive.digital/rest/1/{webhook_code}/hints.hint.update.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          --data '{
          "id": 1084,
          "name": "REST doc hint updated"
        }'

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

{
          "result": {
            "result": {
              "id": 1084,
              "pageId": 98,
              "pageName": "REST doc test 20260902170002",
              "name": "REST doc hint updated",
              "selector": "",
              "code": "",
              "detailText": "<p>Test content</p>",
              "active": true,
              "sort": 500,
              "form": "",
              "event": "",
              "hideNext": "N",
              "hideSkip": "N",
              "showByAnchor": "N",
              "showByQueue": "Y",
              "radius": "",
              "timeout": "",
              "nextText": "",
              "linkForNextBtn": "",
              "dateCreate": "02.09.2026 17:00:03",
              "timestampX": "02.09.2026 17:00:03",
              "createdBy": 1,
              "modifiedBy": 1
            },
            "error": null
          },
          "time": {
            "start": 1788357603,
            "finish": 1788357603.446964,
            "duration": 0.4469640254974365,
            "processing": 0,
            "date_start": "2026-09-02T17:00:03+03:00",
            "date_finish": "2026-09-02T17:00:03+03:00"
          }
        }

См. также

Предыдущая
hints.hint.add
Следующая
hints.hint.delete