hints.hint.add

Scope: hints

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

Создаёт подсказку (элемент инфоблока).

HTTP: POST

Побочные эффекты: создаёт элемент инфоблока подсказок.

Обязательны pageId, name и непустой detailText (HTML; допускается только медиа без текста). Поля form и event — xmlId из hints.hint.form.list и hints.hint.event.list. Checkbox-поля: Y/N или bool. При showByAnchor=Y обязателен непустой code.

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

Параметр Тип Обяз. Описание
pageId int да ID страницы
name string да Название
detailText string да HTML-содержимое
selector string нет CSS-селектор (санитизация XSS)
code string нет Код якоря
active bool нет default true
sort int нет default 500
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 Нет pageId; пустые name/detailText; пустой code при showByAnchor; неизвестный xmlId в form/event; инфоблок не настроен
PAGE_NOT_FOUND Страница с указанным pageId не найдена
INTERNAL_ERROR Внутренняя ошибка сервера

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

curl -X POST "https://76592.dev.wehive.digital/rest/1/{webhook_code}/hints.hint.add.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          --data '{
          "name": "REST doc hint",
          "detailText": "<p>Test content</p>",
          "pageId": 98,
          "showByQueue": "Y"
        }'

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

{
          "result": {
            "result": {
              "id": 1084,
              "pageId": 98,
              "pageName": "REST doc test 20260902170002",
              "name": "REST doc hint",
              "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.363984,
            "duration": 0.3639841079711914,
            "processing": 0,
            "date_start": "2026-09-02T17:00:03+03:00",
            "date_finish": "2026-09-02T17:00:03+03:00"
          }
        }

См. также

Предыдущая
hints.hint.get
Следующая
hints.hint.update