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

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

PATCH /v1/documents/:id

Обновляет поля существующего документа — передайте только изменяемые. Системные поля (даты, автор, ссылки на файлы) доступны только для чтения. Полный список — в справочнике полей.

Параметры

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

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

Поле Тип Обяз. Описание
values object нет Значения полей-меток шаблона в виде «метка — значение»
values.DocumentNumber string нет Номер документа. Из этой метки заполняется поле number
stampsEnabled boolean нет Печати и подписи. false выключает печати. true их не включает: ответ приходит со stampsEnabled: false. Печати включаются, если поле не передано, поэтому чтобы оставить их выключенными, передайте stampsEnabled: false в каждом запросе

Поля title, number, templateId, value и fileId запрос принимает без ошибки, но не меняет. Название документ получает при создании и сохраняет после обновлений.

Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/documents/2001" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "values": { "DocumentNumber": "2026-002" },
    "stampsEnabled": false
  }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/documents/2001" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "values": { "DocumentNumber": "2026-002" },
    "stampsEnabled": false
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/documents/2001', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    values: { DocumentNumber: '2026-002' },
    stampsEnabled: false,
  }),
})

const { success, data } = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/documents/2001', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    values: { DocumentNumber: '2026-002' },
    stampsEnabled: false,
  }),
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Объект документа со всеми полями — см. Поля документа

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

JSON 
{
  "success": true,
  "data": {
    "downloadUrl": "/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getfile&SITE_ID=s1&id=2001&ts=1791526169",
    "publicUrl": null,
    "title": "ТЕСТ VibeDocs A B-001",
    "number": "2026-002",
    "id": 2001,
    "createTime": "2026-10-08T18:12:02.000Z",
    "createdBy": 1317,
    "updateTime": "2026-10-09T06:09:29.000Z",
    "updatedBy": 1317,
    "stampsEnabled": false,
    "isTransformationError": false,
    "value": "VIBE-DOCS-B-1",
    "values": {
      "productsTableVariant": "",
      "_creationMethod": "rest",
      "DocumentNumber": "2026-002"
    },
    "templateId": 237,
    "provider": "Bitrix\\DocumentGenerator\\DataProvider\\Rest",
    "pullTag": "TRANSFORMDOCUMENT2001",
    "emailDiskFile": 10609,
    "downloadUrlMachine": "https://vibecode.bitrix24.tech/v1/documents/2001/download"
  }
}

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

404 — документ не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Документ не найден"
  }
}

Ошибки

HTTP Код Описание
400 READONLY_FIELD В теле передано поле только для чтения — в том числе состояние преобразования в PDF (isTransformationError, transformationErrorCode, transformationErrorMessage, transformationCancelReason) и тег подписки pullTag. Проверка идёт до обращения к Битрикс24, поэтому этот отказ приходит и на несуществующем id
404 ENTITY_NOT_FOUND Документа с указанным id не существует
403 SCOPE_DENIED Ключу не хватает скоупа documentgenerator
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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