#Обновить шаблон

PATCH /v1/doc-templates/:id

Частично обновляет шаблон документа. Передавайте плоско в корне 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

Поля только для чтения (id, createTime, updateTime, isDeleted, download, downloadMachine, providers, provider) в теле запроса не принимаются.

#Примеры

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

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

Terminal 
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 — личный ключ

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

javascript 
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 Адрес скачивания для программного доступа

Полная схема полей шаблона — Поля шаблона.

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

JSON 
{
  "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://<portal>/rest/1/<token>/documentgenerator.api.template.download/?token=<token>"
  }
}

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

404 — шаблон не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Шаблон не найден"
  }
}

#Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Шаблона с указанным id нет (сообщение «Шаблон не найден»)
403 SCOPE_DENIED Ключу не хватает скоупа documentgenerator
401 TOKEN_MISSING У ключа нет настроенных токенов

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

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