Для AI-агентов: markdown этой страницы — /docs-content/entities/bizproc-templates/create.md индекс документации — /llms.txt
Загрузить шаблон
POST /v1/bizproc-templates
Загружает шаблон бизнес-процесса из файла BPT и привязывает его к типу документа. Поля передаются плоско в корне JSON, без обёртки fields.
Поля запроса (body)
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
ПолеtemplateData |
Типarray | Обяз.да | ОписаниеФайл шаблона из двух элементов — имя файла и его содержимое в base64. Пример: ["process.bpt", "eNrlWNtO41YUfe..."] |
ПолеdocumentType |
Типarray | Обяз.да | ОписаниеТип документа [модуль, объект, тип]. Значения:["crm", "CCrmDocumentLead", "LEAD"] — лиды["crm", "CCrmDocumentContact", "CONTACT"] — контакты["crm", "CCrmDocumentCompany", "COMPANY"] — компании["crm", "CCrmDocumentDeal", "DEAL"] — сделки["crm", "Bitrix\\Crm\\Integration\\BizProc\\Document\\Quote", "QUOTE"] — предложения["crm", "Bitrix\\Crm\\Integration\\BizProc\\Document\\SmartInvoice", "SMART_INVOICE"] — счета["crm", "Bitrix\\Crm\\Integration\\BizProc\\Document\\Dynamic", "DYNAMIC_<entityTypeId>"] — смарт-процессы, <entityTypeId> из поля entityTypeId в GET /v1/smart-processes["lists", "BizprocDocument", "iblock_<id>"] — процессы в ленте новостей["lists", "Bitrix\\Lists\\BizprocDocumentLists", "iblock_<id>"] — списки в группах["disk", "Bitrix\\Disk\\BizProcDocument", "STORAGE_<id>"] — документы Диска |
Полеname |
Типstring | Обяз.да | ОписаниеНазвание шаблона. Пустое значение Битрикс24 отклоняет |
Полеdescription |
Типstring | Обяз.нет | ОписаниеОписание шаблона |
ПолеautoExecute |
Типnumber | Обяз.нет | ОписаниеУсловие автозапуска: 0 — без автозапуска, 1 — при создании документа, 2 — при изменении, 3 — при создании и изменении. По умолчанию 0 |
Примеры
Загружать шаблоны можно только ключом авторизации — оба примера отправляют ключ авторизации и заголовок Authorization: Bearer. Токен сессии выдаёт OAuth-авторизация и живёт 24 часа без продления — Передача ключа.
curl — OAuth-приложение
curl -X POST "https://vibecode.bitrix24.tech/v1/bizproc-templates" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"documentType": ["crm", "CCrmDocumentDeal", "DEAL"],
"name": "Согласование сделки",
"description": "Загружен из приложения",
"autoExecute": 0,
"templateData": ["approval.bpt", "eNrlWNtO41YUfe..."]
}'
JavaScript — OAuth-приложение
import { readFile } from 'node:fs/promises'
const file = await readFile('approval.bpt')
const res = await fetch('https://vibecode.bitrix24.tech/v1/bizproc-templates', {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({
documentType: ['crm', 'CCrmDocumentDeal', 'DEAL'],
name: 'Согласование сделки',
description: 'Загружен из приложения',
autoExecute: 0,
templateData: ['approval.bpt', file.toString('base64')],
}),
})
const { success, data } = await res.json()
console.log(`Идентификатор шаблона: ${data.id}`)
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | ОписаниеВсегда true при успехе |
Полеdata.id |
Типnumber | ОписаниеИдентификатор созданного шаблона. Указывается в путях обновления и удаления |
Пример ответа
{
"success": true,
"data": {
"id": 1215
}
}
Пример ответа при ошибке
400 — не передан файл шаблона:
{
"success": false,
"error": {
"code": "MISSING_REQUIRED_FIELDS",
"message": "Body field \"templateData\" is required to create bizprocTemplate."
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP400 | КодMISSING_REQUIRED_FIELDS |
ОписаниеНе передано поле templateData |
| HTTP409 | КодBIZPROC_MODULE_NOT_ENABLED |
ОписаниеБизнес-процессов на портале нет: модуль не входит в тариф либо выключен в настройках портала. Попросите администратора портала включить бизнес-процессы — до этого метод отвечает так же при любом числе повторов |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеНе передан name — сообщение Empty template name!, b24Code содержит ERROR_TEMPLATE_VALIDATION_FAILURE |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеНе передан documentType или указан неизвестный тип — сообщение Incorrect field DOCUMENT_TYPE!, b24Code содержит ERROR_TEMPLATE_VALIDATION_FAILURE |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеСодержимое файла не распознано как шаблон. Текст message приходит от Битрикс24 на языке аккаунта, на русском — Некорректный шаблон бизнес-процесса |
| 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 — Ошибки.
Известные особенности
Файл .bpt готовится в Битрикс24. Настройте процесс в конструкторе бизнес-процессов и выгрузите его в файл — этот файл и передаётся в templateData. Собрать содержимое .bpt через API нельзя, поэтому подготовка файла остаётся ручным шагом.
Ответ не показывает, что записалось. Приходит только id, поэтому применённые значения проверяйте чтением записи через GET /v1/bizproc-templates с фильтром по id.