hints.page.update

Scope: hints

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

Обновляет страницу подсказок. Передаются только изменяемые поля (частичное обновление).

HTTP: POST

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

Параметр id обязателен (alias: pageId, sectionId). Поле url также принимает alias UF_HINT_DIR. URL страницы должен быть уникальным. Если указанный URL уже используется другой страницей, метод вернёт ошибку PAGE_DUPLICATE_URL. hintType — xmlId значения UF_HINT_TYPE.

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

Параметр Тип Обяз. Описание
id int да ID страницы (alias: pageId, sectionId)
name string нет Название (не может быть пустым, если передано)
url string нет URL страницы (alias: UF_HINT_DIR)
hintType string нет xmlId типа сценария
active bool нет Активность

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

result.result — обновлённая страница (поля как у hints.page.get).

Поле Тип Описание
id int ID страницы
name string Название
url string URL шаблон
hintType string xmlId типа сценария
active bool Активность
sort int Сортировка
hintsCount int Число подсказок
viewsCount int Число просмотров

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
MODULE_DISABLED Модуль выключен на сайте
PERMISSION_DENIED Нет права записи (W)
VALIDATION_ERROR Не указан или некорректный id; пустой name; некорректный формат url
PAGE_NOT_FOUND Страница не найдена
PAGE_DUPLICATE_URL Другая страница с таким URL уже существует
INTERNAL_ERROR Внутренняя ошибка сервера

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

curl -X POST "https://76592.dev.wehive.digital/rest/1/{webhook_code}/hints.page.update.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          --data '{
          "id": 94,
          "active": true
        }'

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

{
          "result": {
            "result": {
              "id": 94,
              "name": "(1) Поиск сотрудника",
              "url": "/company/",
              "hintType": "step",
              "active": true,
              "sort": 500,
              "hintsCount": 1,
              "viewsCount": 0
            },
            "error": null
          },
          "time": {
            "start": 1788357603,
            "finish": 1788357603.753917,
            "duration": 0.7539169788360596,
            "processing": 0,
            "date_start": "2026-09-02T17:00:03+03:00",
            "date_finish": "2026-09-02T17:00:03+03:00"
          }
        }

См. также

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