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

`PATCH /v1/note/documents/:id`

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

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `id` (path) | integer | да | Идентификатор документа |

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

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

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

## Примеры

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

```bash
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-приложение

```bash
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.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 | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | Не передан ни `title`, ни `markdown`, либо `id` неверного типа |
| 403 | `BITRIX_ACCESS_DENIED` | Нет права редактировать документ |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ в режиме «только чтение» |
| 404 | `ENTITY_NOT_FOUND` | Документ не существует, архивный или в корзине |
| 422 | `BITRIX_ERROR` | Есть несохранённые изменения и передан `overwrite: false`, либо размер `markdown` превышает лимит. Текст ошибки в `error.message` |
| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `note` |
| 401 | `TOKEN_MISSING` | У API-ключа не настроены токены |

Полный список общих ошибок API — [Ошибки](/docs/errors).

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

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

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

- [Создать документ](/docs/note/documents/create)
- [Получить документ](/docs/note/documents/get)
- [Базы знаний](/docs/note/collections)
- [Обзор Базы знаний](/docs/note)