Для AI-агентов: markdown этой страницы — /docs-content/note/documents/update.md индекс документации — /llms.txt

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

PATCH /v1/note/documents/:id

Обновляет заголовок и/или содержимое документа. Передача markdown полностью заменяет текущее содержимое.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типinteger Обяз.да ОписаниеИдентификатор документа. Список: GET /v1/note/documents

Поля запроса (body)

Поле Тип Обяз. Описание
Полеtitle Типstring Обяз.да¹ ОписаниеНовый заголовок документа
Полеmarkdown Типstring Обяз.да¹ ОписаниеНовое содержимое в Markdown. Полностью заменяет текущее. Максимум 1 048 576 байт (1 МиБ)
Полеoverwrite Типboolean Обяз.нет ОписаниеПереписать содержимое при несохранённых изменениях. По умолчанию false

¹ Хотя бы одно из полей title или markdown обязано присутствовать.

Примеры

curl — личный ключ

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/note/documents/77 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Глава 1 (ред.)",
    "markdown": "# Глава 1\n\nОбновлённый текст",
    "overwrite": false
  }'

curl — OAuth-приложение

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/note/documents/77 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Глава 1 (ред.)",
    "markdown": "# Глава 1\n\nОбновлённый текст",
    "overwrite": false
  }'

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/documents/77', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Глава 1 (ред.)',
    markdown: '# Глава 1\n\nОбновлённый текст',
    overwrite: false,
  }),
})
const { success, data } = await res.json()
console.log(data.updated)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/documents/77', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Глава 1 (ред.)',
    markdown: '# Глава 1\n\nОбновлённый текст',
    overwrite: false,
  }),
})
const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типobject ОписаниеРезультат обновления
Полеdata.updated Типboolean Описаниеtrue при успешном обновлении

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

JSON 
{
  "success": true,
  "data": { "updated": true }
}

Пример ответа при ошибке

400 — не передано ни одного изменяемого поля:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "at least one of `title` or `markdown` must be provided"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНе передан ни title, ни markdown, либо id неверного типа
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеНет права редактировать документ
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч в режиме «только чтение»
HTTP404 КодENTITY_NOT_FOUND ОписаниеДокумент не существует, архивный или в корзине
HTTP422 КодBITRIX_ERROR ОписаниеЕсть несохранённые изменения и передан overwrite: false, либо размер markdown превышает лимит. Текст ошибки в error.message
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа note
HTTP401 КодTOKEN_MISSING ОписаниеУ API-ключа не настроены токены

Полный список общих ошибок API — Ошибки.

Известные особенности

Разрешение конфликта совместного редактирования. Если у документа остались несохранённые изменения совместного редактора, запрос с overwrite: false содержимое не перезаписывает и возвращает 422 BITRIX_ERROR. Повторный запрос с overwrite: true записывает markdown поверх несохранённых изменений.

Смотрите также