метод REST scope: note

note.document.update

Обновить документ

Кто может выполнять: пользователь с доступом к модулю База знаний и правом «Редактирование» для нужного документа или базы знаний документа

Описание

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод note.document.update обновляет заголовок и/или содержимое документа.

Параметры

id integer обязательный

Идентификатор документа.

Идентификатор можно получить методом note.document.tree.list

fields object обязательный

Объект с полями, которые нужно изменить. Описание структуры объекта

overwrite boolean необязательный

Определяет, нужно ли принудительно перезаписать содержимое документа, если у него есть несохраненные изменения совместного редактора.

Возможные значения:

  • true — перезаписать содержимое документа
  • false — не перезаписывать содержимое, если есть несохраненные изменения

По умолчанию: false

Используйте, если передаете fields.markdown

Параметр fields

title string необязательный

Новый заголовок документа.

Заголовок документа не должен превышать 255 символов.

Передайте fields.title, fields.markdown или оба поля сразу

markdown string необязательный

Новое содержимое документа в Markdown.

Чтобы добавить в документ файл, вставьте assetMarkdown, полученный методом note.file.get или note.file.add, отдельной строкой с начала строки, без префикса и суффикса в той же строке.

Для изображений и видео блок можно дополнить параметрами width и align, например [[image fileId=5001 width=30.98 align=left]].

Параметр width задает ширину в процентах от контейнера редактора. Значение может содержать до двух знаков после запятой. Для блока без align допустим диапазон от 10 до 100, для align=left или align=right — от 10 до 70.

Параметр align задает выравнивание. Возможные значения: left, right. Центрирование применяется по умолчанию, поэтому значение center передавать не нужно.

Максимальный размер: 1 048 576 байт.

Передайте fields.title, fields.markdown или оба поля сразу

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":77,"fields":{"title":"Глава 1 (обновлено)","markdown":"# Глава 1\n\nОбновленный текст\n\n[[image fileId=5001 width=30.98 align=left]]"},"overwrite":false}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.document.update

Ответ

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 77,
            "collectionId": 42,
            "parentId": 10,
            "title": "Глава 1 (обновлено)",
            "markdown": "# Глава 1\n\nОбновленный текст\n\n[[image fileId=5001 width=30.98 align=left]]",
            "position": 5,
            "createdBy": 1,
            "updatedBy": 1,
            "createdAt": "2026-04-20T12:00:00Z",
            "updatedAt": "2026-04-21T09:15:30Z"
        }
    },
    "time": {
        "start": 1780391100,
        "finish": 1780391100.266341,
        "duration": 0.266340970993042,
        "processing": 0.22421908378601074,
        "date_start": "2026-06-16T12:05:00+03:00",
        "date_finish": "2026-06-16T12:05:00+03:00",
        "operating_reset_at": 1780391700,
        "operating": 0
    }
}

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

result object

Объект с результатом обновления документа

item object

Объект документа после обновления

id integer

Идентификатор документа

collectionId integer

Идентификатор базы знаний или null, если документ доступен через прямой доступ к документу

parentId integer

Идентификатор родительского документа или null

title string

Заголовок документа

markdown string

Содержимое документа в Markdown

position integer

Позиция документа среди соседних страниц

createdBy integer

Идентификатор автора документа

updatedBy integer

Идентификатор последнего редактора документа

createdAt datetime

Дата и время создания документа в UTC

updatedAt datetime

Дата и время последнего изменения документа в UTC

time time

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
    "error": {
        "code": "NOTE_EMPTY_UPDATE",
        "message": "Запрос не содержит изменяемых полей"
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
id fields Обязательное поле #FIELD# не указано Добавьте указанное поле в тело запроса
id overwrite В поле #FIELD# требуется тип данных #TYPE# для такого запроса Убедитесь, что передаваемое значение нужного типа

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.