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

PATCH /v1/documents/:id

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

#Часто обновляемые поля

Параметр Тип Описание
title string Название документа
number string Номер документа
stampsEnabled boolean Печати и подписи на документе
values object Значения полей-меток шаблона

#Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/documents/51" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Договор поставки 2026-001 (ред.)",
    "stampsEnabled": true
  }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/documents/51" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Договор поставки 2026-001 (ред.)",
    "stampsEnabled": true
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/documents/51', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Договор поставки 2026-001 (ред.)',
    stampsEnabled: true,
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/documents/51', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Договор поставки 2026-001 (ред.)',
    stampsEnabled: true,
  }),
})

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

#Поля ответа

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

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

JSON 
{
  "success": true,
  "data": {
    "id": 51,
    "title": "Договор поставки 2026-001 (ред.)",
    "number": "2026-001",
    "templateId": 53,
    "provider": "Bitrix\\DocumentGenerator\\DataProvider\\Rest",
    "value": "ORDER-1024",
    "createTime": "2026-03-18T17:27:48+03:00",
    "updateTime": "2026-03-20T09:14:11+03:00",
    "createdBy": 503,
    "updatedBy": 503,
    "values": { "DocumentNumber": "2026-001" },
    "stampsEnabled": true,
    "publicUrl": "https://example.bitrix24.ru/~aBcDeF",
    "downloadUrl": "https://example.bitrix24.ru/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getfile&id=51",
    "pdfUrl": "https://example.bitrix24.ru/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getpdf&id=51"
  }
}

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

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

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

#Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Документа с указанным id не существует
403 SCOPE_DENIED Ключу не хватает скоупа documentgenerator
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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