hints.page.add

Scope: hints

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

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

HTTP: POST

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

URL нормализуется через шаблон портала; дубликат URL → PAGE_DUPLICATE_URL. Формат URL: путь от /, символы [a-zA-Z0-9/_-].

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

Параметр Тип Обяз. Описание
name string да Название страницы
url string да URL страницы (alias: UF_HINT_DIR)
hintType string нет xmlId типа сценария; по умолчанию step
active bool нет Активность; по умолчанию true

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

result.result — созданная страница (та же форма, что у hints.page.get).

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

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

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

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

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

curl -X POST "https://76592.dev.wehive.digital/rest/1/{webhook_code}/hints.page.add.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          --data '{
          "name": "REST doc test 20260902170002",
          "url": "/rest-doc-test-20260902170002/",
          "hintType": "step",
          "active": true
        }'

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

{
          "result": {
            "result": {
              "id": 98,
              "name": "REST doc test 20260902170002",
              "url": "/rest-doc-test-20260902170002/",
              "hintType": "step",
              "active": true,
              "sort": 500,
              "hintsCount": 0,
              "viewsCount": 0
            },
            "error": null
          },
          "time": {
            "start": 1788357603,
            "finish": 1788357603.240057,
            "duration": 0.24005699157714844,
            "processing": 0,
            "date_start": "2026-09-02T17:00:03+03:00",
            "date_finish": "2026-09-02T17:00:03+03:00"
          }
        }

См. также

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