knowledgebase.article.update

Scope: knowledgebase

Кто может вызывать: IblockRights::canEditElement(); для смены раздела — canBindElementToSection() на каждый целевой раздел. Подробнее: Права доступа

Обновить статью базы знаний

HTTP: POST

Побочные эффекты: обновляет элемент инфоблока; при saveCurrentVersion=true сохраняет снимок текущей версии в ArticleVersionsTable

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

Параметр Тип Обяз. Описание
id int да ID статьи (алиасы: articleId, elementId)
name string нет Название
detailText string нет Текст статьи
sectionId int|array нет ID раздела или массив разделов
active bool|string нет Активность
saveCurrentVersion bool|string нет Сохранить текущую версию перед обновлением (алиас: SAVE_CURRENT_VERSION)
detailTextType string нет Тип текста: text или html
tags array|string нет Теги
disk array нет ID файлов диска
extendedTextEditor bool|string нет Расширенный HTML-редактор
disallowPublicLink bool|string нет Запретить публичную ссылку
disableComments bool|string нет Отключить комментарии

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

Ответ в конверте модуля: result.result — обновлённая статья (формат как у article.get); result.error.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR Некорректные параметры или ошибка записи
ARTICLE_NOT_FOUND Статья не найдена
PERMISSION_DENIED Нет прав на редактирование или привязку к разделу
INTERNAL_ERROR Внутренняя ошибка сервера

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/knowledgebase.article.update.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          --data '{
          "id": 501,
          "name": "Инструкция по оформлению отпуска (обновлено)",
          "detailText": "Обновлённый текст инструкции.",
          "saveCurrentVersion": true
        }'

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

{
          "result": {
            "result": {
              "id": 1078,
              "name": "REST Docs test article updated",
              "detailText": "Updated body",
              "createdAt": "03.09.2026 15:25",
              "updatedAt": "03.09.2026 15:25",
              "tags": [],
              "createdBy": {
                "id": 1,
                "fullName": "Портала Админ",
                "icon": "",
                "position": ""
              },
              "updatedBy": {
                "id": 1,
                "fullName": "Портала Админ",
                "icon": "",
                "position": ""
              },
              "disk": [],
              "sections": [
                {
                  "id": 96,
                  "name": "Регламенты и инструкции"
                }
              ],
              "sectionId": 96,
              "extendedTextEditor": false,
              "isBlockNote": false,
              "publicUrl": "",
              "internalUrl": "http://76569.dev.wehive.digital/knowledgebase/show/1078/",
              "isPublicUrlEnabled": true,
              "isCommentsEnabled": true,
              "disallowPublicLink": false,
              "disableComments": false,
              "commentsCount": 0,
              "newCommentsCount": 0
            },
            "error": null
          }
        }

См. также

Предыдущая
knowledgebase.article.restoreVersion
Следующая
Обзор раздела