Обновить документ note.document.update

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: note

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

Метод относится к 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 или оба поля сразу

Если в данный момент документ редактируют в интерфейсе, метод вернет ошибку NOTE_DOCUMENT_HAS_UNSAVED_CHANGES. Чтобы принудительно перезаписать содержимое, повторите запрос с overwrite=true. Всем активным редакторам через P&P-событие будет отправлен сигнал перезагрузить актуальное содержимое.

Примеры кода

Как использовать примеры в документации

Вызов нового api отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/note.document.update

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

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

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,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.document.update

import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type DocumentUpdateResult = {
  item: {
    id: number
    collectionId: number | null
    parentId: number | null
    title: string
    markdown: string
    position: number
    createdBy: number
    updatedBy: number
    createdAt: string
    updatedAt: string
  }
}

try {
  const response = await $b24.actions.v3.call.make<DocumentUpdateResult>({
    method: 'note.document.update',
    params: {
      id: 77,
      fields: {
        title: 'Глава 1 (обновлено)',
        markdown: '# Глава 1\n\nОбновленный текст\n\n[[image fileId=5001 width=30.98 align=left]]',
      },
      overwrite: false,
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Document updated:', result.item.id, result.item.title)
  }
} catch (error) {
  console.error(error)
}

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function updateDocument() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'note.document.update',
        params: {
          id: 77,
          fields: {
            title: 'Глава 1 (обновлено)',
            markdown: '# Глава 1\n\nОбновленный текст\n\n[[image fileId=5001 width=30.98 align=left]]',
          },
          overwrite: false,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Document updated:', result.item.id, result.item.title)
    } catch (error) {
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updateDocument)
</script>

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'note.document.update',
            [
                'id' => 77,
                'fields' => [
                    'title' => 'Глава 1 (обновлено)',
                    'markdown' => "# Глава 1\n\nОбновленный текст\n\n[[image fileId=5001 width=30.98 align=left]]",
                ],
                'overwrite' => false,
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error updating document: ' . $e->getMessage();
}

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

BX24.callMethod(
    'note.document.update',
    {
        id: 77,
        fields: {
            title: 'Глава 1 (обновлено)',
            markdown: '# Глава 1\n\nОбновленный текст\n\n[[image fileId=5001 width=30.98 align=left]]'
        },
        overwrite: false
    },
    function(result){
        console.info(result.data());
        console.log(result);
    }
);

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

require_once('crest.php');

$result = CRest::call(
    'note.document.update',
    [
        'id' => 77,
        'fields' => [
            'title' => 'Глава 1 (обновлено)',
            'markdown' => "# Глава 1\n\nОбновленный текст\n\n[[image fileId=5001 width=30.98 align=left]]"
        ],
        'overwrite' => false
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "note.document.update", b24.Params{
	"id": 77,
	"fields": b24.Params{
		"title":    "Глава 1 (обновлено)",
		"markdown": "# Глава 1\n\nОбновленный текст\n\n[[image fileId=5001 width=30.98 align=left]]",
	},
	"overwrite": false,
})
if err != nil {
	return fmt.Errorf("note.document.update: %w", err)
}

// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
	return fmt.Errorf("в ответе нет ключа item")
}

var item struct {
	ID           b24.ID `json:"id"`
	CollectionID b24.ID `json:"collectionId"`
	ParentID     b24.ID `json:"parentId"`
	Title        string `json:"title"`
	Markdown     string `json:"markdown"`
	Position     int    `json:"position"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.CollectionID)

Обработка ответа

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": "Запрос не содержит изменяемых полей"
    }
}

Название `тип`	Описание
error.code `string`	Строковый код ошибки. Используйте для идентификации типа исключения
error.message `string`	Текстовое описание ошибки
error.validation `array`	Массив c деталями ошибки. Присутствует только в ошибках валидации данных `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Название поля, в котором возникла ошибка валидации
error.validation[].message `string`	Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`id` `fields`	Обязательное поле `#FIELD#` не указано	Добавьте указанное поле в тело запроса
`id` `overwrite`	В поле `#FIELD#` требуется тип данных `#TYPE#` для такого запроса	Убедитесь, что передаваемое значение нужного типа

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`title` `markdown`	В поле `#FIELD#` требуется тип данных `#TYPE#` для такого запроса	Убедитесь, что передаваемое значение нужного типа
`title`	Заголовок документа не может быть пустым	Передайте непустую строку в поле `fields.title`
`title`	Заголовок документа не должен превышать 255 символов	Сократите значение `fields.title`

Код ошибки: NOTE_EMPTY_UPDATE

Поле	Описание ошибки	Как исправить
`fields.title` `fields.markdown`	Запрос не содержит изменяемых полей	Передайте `fields.title`, `fields.markdown` или оба поля сразу

Код ошибки: NOTE_MARKDOWN_TOO_LARGE

Поле	Описание ошибки	Как исправить
`markdown`	Содержимое документа слишком большое. Максимально допустимый размер — `1 048 576` байт	Сократите содержимое `fields.markdown`

Ошибка конфликта изменений

Код ошибки: NOTE_DOCUMENT_HAS_UNSAVED_CHANGES

Поле	Описание ошибки	Как исправить
`overwrite`	У документа есть несохраненные изменения. Передайте параметр `overwrite=true`, чтобы перезаписать содержимое	Повторите запрос с `overwrite=true`, если нужно принудительно заменить содержимое документа

Ошибки доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Доступ запрещен	У пользователя нет доступа к модулю База знаний или права редактировать документ

Ошибка отсутствия объекта

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Поле	Описание ошибки	Как исправить
`id`	Документ не найден	Проверьте, что документ существует, не архивирован и не находится в корзине

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Была ли статья полезна?

Создать документ

Получить документ

Обновить документ note.document.update

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

Параметр fieldsПараметр fields

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

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

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

Возможные коды ошибокВозможные коды ошибок

Ошибки валидации запросаОшибки валидации запроса

Ошибка конфликта измененийОшибка конфликта изменений

Ошибки доступаОшибки доступа

Ошибка отсутствия объектаОшибка отсутствия объекта

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение

Была ли статья полезна?

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

Параметр fields

Примеры кода

Обработка ответа

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

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

Возможные коды ошибок

Ошибки валидации запроса

Ошибка конфликта изменений

Ошибки доступа

Ошибка отсутствия объекта

Статусы и коды системных ошибок

Продолжите изучение