Для AI-агентов: markdown этой страницы — /docs-content/entities/bizproc-templates/update.md индекс документации — /llms.txt
Обновить шаблон
PATCH /v1/bizproc-templates/:id
Изменяет шаблон бизнес-процесса, загруженный этим же приложением. Поля передаются плоско в корне JSON, без обёртки fields.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
Параметрid (path) |
Типnumber | Обяз.да | ОписаниеИдентификатор шаблона. Источник: GET /v1/bizproc-templates |
Поля запроса (body)
Изменяются четыре поля. Остальные поля записи задаются при загрузке файла и запросом на обновление не меняются.
| Поле | Тип | Описание |
|---|---|---|
Полеname |
Типstring | ОписаниеНазвание шаблона |
Полеdescription |
Типstring | ОписаниеОписание шаблона |
ПолеautoExecute |
Типnumber | ОписаниеУсловие автозапуска: 0 — без автозапуска, 1 — при создании документа, 2 — при изменении, 3 — при создании и изменении |
ПолеtemplateData |
Типarray | ОписаниеНовый файл шаблона из двух элементов — имя файла и его содержимое в base64 |
Примеры
Обновлять шаблоны можно только ключом авторизации — оба примера отправляют ключ авторизации и заголовок Authorization: Bearer. Токен сессии выдаёт OAuth-авторизация и живёт 24 часа без продления — Передача ключа.
curl — OAuth-приложение
curl -X PATCH "https://vibecode.bitrix24.tech/v1/bizproc-templates/1215" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Согласование сделки — версия 2",
"autoExecute": 1
}'
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/bizproc-templates/1215', {
method: 'PATCH',
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({
name: 'Согласование сделки — версия 2',
autoExecute: 1,
}),
})
const { success, data } = await res.json()
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | ОписаниеВсегда true при успехе |
Полеdata.id |
Типnumber | ОписаниеИдентификатор обновлённого шаблона |
Пример ответа
{
"success": true,
"data": {
"id": 1215
}
}
Пример ответа при ошибке
422 — шаблон загружен другим приложением или создан в конструкторе Битрикс24:
{
"success": false,
"error": {
"code": "BITRIX_ERROR",
"message": "You can update ONLY templates created by current application"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP409 | КодBIZPROC_MODULE_NOT_ENABLED |
ОписаниеБизнес-процессов на портале нет: модуль не входит в тариф либо выключен в настройках портала. Попросите администратора портала включить бизнес-процессы — до этого метод отвечает так же при любом числе повторов |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеШаблон загружен другим приложением — сообщение You can update ONLY templates created by current application |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеШаблона с указанным id нет — сообщение Workflow template not found., поле b24Code содержит ERROR_TEMPLATE_NOT_FOUND |
| HTTP400 | КодEMPTY_UPDATE_BODY |
ОписаниеТело запроса пустое — передайте хотя бы одно поле |
| HTTP400 | КодREADONLY_FIELD |
ОписаниеВ теле передано поле только для чтения, например id |
| HTTP403 | КодOAUTH_REQUIRED |
ОписаниеЗапрос отправлен API-ключом. Обновлять шаблоны можно только ключом авторизации |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеКлюч авторизации без заголовка Authorization: Bearer |
| HTTP401 | КодWRONG_AUTH_SCHEME |
ОписаниеКлюч авторизации отправлен в заголовке Authorization: Bearer. Сам ключ передаётся в X-Api-Key, а Authorization: Bearer несёт токен сессии |
| HTTP401 | КодINVALID_SESSION |
ОписаниеТокен сессии истёк или недействителен — пройдите авторизацию заново |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеКлючу не хватает скоупа bizproc |
При ошибке на стороне Битрикс24 объект error дополняется полем b24Code — машинным кодом причины.
Полный список общих ошибок API — Ошибки.
Известные особенности
Обновляются только свои шаблоны. Изменить можно шаблон, загруженный тем же приложением, чьим ключом авторизации отправлен запрос. Шаблоны из конструктора Битрикс24 и шаблоны других приложений возвращают 422 и остаются нетронутыми.
documentType не меняется после загрузки. В схеме GET /v1/bizproc-templates/fields поле помечено readonly: false, но запрос на обновление применяет только четыре поля из таблицы выше — тип документа задаётся при загрузке файла. Запрос с documentType вернёт 200, значение останется прежним.
Имя поля вне списка выше не вызывает ошибку. Ответ приходит с кодом 200, значение не применяется. Проверяйте результат чтением записи через GET /v1/bizproc-templates с фильтром по id.
Замена файла помечает шаблон как изменённый. После обновления templateData поле isModified в ответе списка становится true.