Для AI-агентов: markdown этой страницы — /docs-content/entities/doc-templates/update.md индекс документации — /llms.txt
Обновить шаблон
PATCH /v1/doc-templates/:id
Частично обновляет шаблон документа, в том числе заменяет его файл .docx. Передавайте плоско в корне JSON только те поля, которые меняете, — остальные значения сохраняются.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
Параметрid (path) |
Типnumber | Обяз.да | ОписаниеИдентификатор шаблона |
Поля запроса (body)
| Поле | Тип | Описание |
|---|---|---|
Полеname |
Типstring | ОписаниеНазвание шаблона |
ПолеnumeratorId |
Типnumber | ОписаниеID нумератора, который присваивает документам порядковые номера |
Полеregion |
Типstring | ОписаниеКод региона шаблона, например ru или by |
Полеcode |
Типstring | ОписаниеСистемный код шаблона для привязки в коде приложения |
Полеactive |
Типstring | ОписаниеДоступность шаблона: Y — включён, N — выключен |
ПолеwithStamps |
Типstring | ОписаниеПечать факсимиле и штампов: Y — добавляются, N — нет |
Полеsort |
Типnumber | ОписаниеПорядок шаблона в списке: чем меньше значение, тем выше |
Полеusers |
Типarray | ОписаниеИдентификаторы сотрудников, которым доступен шаблон. Список: GET /v1/users |
Полеfile |
Типstring | ОписаниеНовое содержимое файла .docx строкой base64. Заменяет файл шаблона, id шаблона сохраняется |
Файл заменяется только через file. Поле fileId, которое при создании шаблона принимает ID объекта Диска, при обновлении не применяется.
Поля только для чтения id, moduleId, createdBy, updatedBy, createTime, updateTime, isDeleted, download, downloadMachine, providers, isDefault, productsTableVariant в теле запроса не принимаются: запрос с любым из них отклоняется с 400 READONLY_FIELD. Модуль-владелец moduleId платформа проставляет сама.
Примеры
curl — личный ключ
curl -X PATCH "https://vibecode.bitrix24.tech/v1/doc-templates/209" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Шаблон договора (ред.)"
}'
curl — OAuth-приложение
curl -X PATCH "https://vibecode.bitrix24.tech/v1/doc-templates/209" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Шаблон договора (ред.)"
}'
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/doc-templates/209', {
method: 'PATCH',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
name: 'Шаблон договора (ред.)',
}),
})
const { success, data } = await res.json()
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/doc-templates/209', {
method: 'PATCH',
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({
name: 'Шаблон договора (ред.)',
}),
})
const { success, data } = await res.json()
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | ОписаниеВсегда true при успехе |
Полеdata |
Типobject | ОписаниеОбновлённый шаблон целиком |
Полеdata.id |
Типnumber | ОписаниеИдентификатор шаблона |
Полеdata.name |
Типstring | ОписаниеНазвание |
Полеdata.region |
Типstring | ОписаниеРегион |
Полеdata.code |
Типstring | null | ОписаниеСистемный код шаблона |
Полеdata.active |
Типstring | ОписаниеДоступность: Y / N |
Полеdata.moduleId |
Типstring | ОписаниеМодуль-источник шаблона |
Полеdata.numeratorId |
Типnumber | ОписаниеИдентификатор нумератора |
Полеdata.withStamps |
Типstring | ОписаниеПечати и подписи: Y / N |
Полеdata.sort |
Типnumber | ОписаниеПорядок в списке |
Полеdata.users |
Типobject | ОписаниеСопоставление идентификаторов сотрудников, которым доступен шаблон |
Полеdata.providers |
Типobject | ОписаниеПоставщики данных шаблона |
Полеdata.isDeleted |
Типboolean | ОписаниеПомечен ли шаблон удалённым |
Полеdata.createTime |
Типstring | ОписаниеДата создания (ISO 8601) |
Полеdata.updateTime |
Типstring | ОписаниеДата изменения (ISO 8601) |
Полеdata.download |
Типstring | ОписаниеАдрес скачивания документа |
Полеdata.downloadMachine |
Типstring | ОписаниеАдрес Vibe API; нужен X-Api-Key со скоупом documentgenerator |
Полная схема полей шаблона — Поля шаблона.
Пример ответа
{
"success": true,
"data": {
"id": 209,
"name": "Шаблон договора (ред.)",
"region": "ru",
"code": null,
"download": "/bitrix/services/main/ajax.php?action=documentgenerator.api.template.download&SITE_ID=s1&id=209&ts=0",
"active": "Y",
"moduleId": "rest",
"numeratorId": 1,
"withStamps": "N",
"providers": {
"bitrix\\documentgenerator\\dataprovider\\rest": "bitrix\\documentgenerator\\dataprovider\\rest"
},
"users": {
"U1": "U1"
},
"isDeleted": false,
"sort": 500,
"createTime": "2026-05-12T09:03:38.000Z",
"updateTime": "2026-05-25T10:00:11.000Z",
"downloadMachine": "https://vibecode.bitrix24.tech/v1/doc-templates/209/download"
}
}
Пример ответа при ошибке
404 — шаблон не найден:
{
"success": false,
"error": {
"code": "ENTITY_NOT_FOUND",
"message": "Шаблон не найден"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP400 | КодREADONLY_FIELD |
ОписаниеВ теле передано поле только для чтения — например модуль-владелец moduleId, который проставляет платформа. Проверка идёт до обращения к Битрикс24, поэтому этот отказ приходит и на несуществующем id |
| HTTP404 | КодENTITY_NOT_FOUND |
ОписаниеШаблона с указанным id нет (сообщение «Шаблон не найден») |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеВ теле передано fileId: null, сообщение «Не заполнено обязательное поле "FILE_ID"». Уберите fileId из тела |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеКлючу не хватает скоупа documentgenerator |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеУ ключа нет настроенных токенов |
Полный список общих ошибок API — Ошибки.
Известные особенности
Вызов с fileId отвечает успехом, но файл не меняет. Вызов с числовым fileId без file отвечает 200 и success: true, а файл шаблона остаётся прежним. Если передать оба поля, применяется file. Поэтому success: true не подтверждает замену: проверяйте файл через GET /v1/doc-templates/:id/download.
Содержимое file не проверяется. Вызов отвечает 200, даже если в file передан не .docx: шаблон сохраняет присланное содержимое, и скачанный после этого файл не открывается как документ. Передавайте в file только содержимое файла .docx.