Добавить новый шаблон crm.documentgenerator.template.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правом "изменения" шаблонов генератора документов
Метод crm.documentgenerator.template.add добавляет новый шаблон документа.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Объект с параметрами шаблона (подробнее) |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
name* |
Название шаблона |
|
file* |
Файл шаблона в формате |
|
numeratorId* |
Идентификатор нумератора. Список доступных нумераторов можно получить методом crm.documentgenerator.numerator.list |
|
region* |
Регион шаблона, например |
|
entityTypeId* |
Массив идентификаторов CRM-объектов, для которых доступен шаблон. Типичные значения:
Для объектов с направлениями добавляется суффикс направления, например:
Для смарт-процессов указывается
|
|
users |
Массив кодов прав доступа, например Поддерживаются коды доступа:
Если параметр не передан или передан пустым, в доступ автоматически добавляется текущий пользователь ( |
|
active |
Активность шаблона: |
|
withStamps |
Подставлять печать и подпись: |
|
sort |
Индекс сортировки |
Примеры кода
Как использовать примеры в документации
Пример добавления шаблона документа, где:
- название шаблона —
Шаблон КП из REST - идентификатор нумератора —
49 - регион шаблона —
ru - идентификаторы CRM-элементов —
2и2_category_0 - код прав доступа —
UA
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"name":"Шаблон КП из REST","file":["template.docx","**base64_encoded_content**"],"numeratorId":49,"region":"ru","entityTypeId":["2","2_category_0"],"users":["UA"],"active":"Y","withStamps":"N","sort":500}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.template.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"name":"Шаблон КП из REST","file":["template.docx","**base64_encoded_content**"],"numeratorId":49,"region":"ru","entityTypeId":["2","2_category_0"],"users":["UA"],"active":"Y","withStamps":"N","sort":500},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.documentgenerator.template.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type TemplateAddResult = {
template: {
id: string,
name: string,
region: string,
code: string | null,
download: string,
downloadMachine: string,
active: string,
moduleId: string,
numeratorId: string,
withStamps: string,
users: Record<string, string>,
isDeleted: string,
sort: string,
entityTypeId: string[],
createTime: ISODate,
updateTime: ISODate,
}
}
try {
const response = await $b24.actions.v2.call.make<TemplateAddResult>({
method: 'crm.documentgenerator.template.add',
params: {
fields: {
name: 'Template KP from REST',
file: ['template.docx', '**base64_encoded_content**'],
numeratorId: 49,
region: 'ru',
entityTypeId: ['2', '2_category_0'],
users: ['UA'],
active: 'Y',
withStamps: 'N',
sort: 500,
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.template.id, result.template.name)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addTemplate() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.documentgenerator.template.add',
params: {
fields: {
name: 'Template KP from REST',
file: ['template.docx', '**base64_encoded_content**'],
numeratorId: 49,
region: 'ru',
entityTypeId: ['2', '2_category_0'],
users: ['UA'],
active: 'Y',
withStamps: 'N',
sort: 500,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.template.id, result.template.name)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addTemplate)
</script>
try {
$response = $b24Service
->core
->call(
'crm.documentgenerator.template.add',
[
'fields' => [
'name' => 'Шаблон КП из REST',
'file' => [
'template.docx',
'**base64_encoded_content**',
],
'numeratorId' => 49,
'region' => 'ru',
'entityTypeId' => ['2', '2_category_0'],
'users' => ['UA'],
'active' => 'Y',
'withStamps' => 'N',
'sort' => 500,
],
]
);
$result = $response
->getResponseData()
->getResult();
echo '<pre>';
print_r($result);
echo '</pre>';
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding template: ' . $e->getMessage();
}
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.documentgenerator.template.add(
fields={
"name": "Шаблон КП из REST",
"file": ["template.docx", "**base64_encoded_content**"],
"numeratorId": 49,
"region": "ru",
"entityTypeId": ["2", "2_category_0"],
"users": ["UA"],
"active": "Y",
"withStamps": "N",
"sort": 500,
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
BX24.callMethod(
'crm.documentgenerator.template.add',
{
fields: {
name: 'Шаблон КП из REST',
file: ['template.docx', '**base64_encoded_content**'],
numeratorId: 49,
region: 'ru',
entityTypeId: ['2', '2_category_0'],
users: ['UA'],
active: 'Y',
withStamps: 'N',
sort: 500,
},
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.documentgenerator.template.add',
[
'fields' => [
'name' => 'Шаблон КП из REST',
'file' => [
'template.docx',
'**base64_encoded_content**',
],
'numeratorId' => 49,
'region' => 'ru',
'entityTypeId' => ['2', '2_category_0'],
'users' => ['UA'],
'active' => 'Y',
'withStamps' => 'N',
'sort' => 500,
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"template": {
"id": "41",
"name": "Шаблон из файла",
"region": "ru",
"code": null,
"download": "https://mysite.ru/bitrix/services/main/ajax.php?action=crm.documentgenerator.template.download&SITE_ID=s1&id=41",
"active": "Y",
"moduleId": "crm",
"numeratorId": "49",
"withStamps": "N",
"users": {
"UA": "UA"
},
"isDeleted": "N",
"sort": "500",
"downloadMachine": "https://mysite.ru/rest/crm.documentgenerator.template.download.json?...",
"entityTypeId": [
"2"
],
"createTime": "2026-03-18T15:54:20+03:00",
"updateTime": "2026-03-18T15:54:20+03:00"
}
},
"time": {
"start": 1773838459,
"finish": 1773838460.813945,
"duration": 1.8139450550079346,
"processing": 1,
"date_start": "2026-03-18T15:54:19+03:00",
"date_finish": "2026-03-18T15:54:20+03:00",
"operating_reset_at": 1773839059,
"operating": 1.0305089950561523
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Содержит объект |
|
time |
Информация о времени выполнения запроса |
Тип template
|
Название |
Описание |
|
id |
Идентификатор шаблона |
|
name |
Название шаблона |
|
region |
Регион шаблона |
|
Символьный код шаблона |
|
|
download |
Ссылка на скачивание файла шаблона |
|
downloadMachine |
Ссылка на скачивание файла шаблона для приложения |
|
active |
Активность шаблона: |
|
moduleId |
Идентификатор модуля |
|
numeratorId |
Идентификатор нумератора |
|
withStamps |
Подставлять печать и подпись: |
|
users |
Объект кодов прав доступа в формате |
|
isDeleted |
Признак удаления шаблона: |
|
sort |
Индекс сортировки |
|
entityTypeId |
Массив идентификаторов CRM-элементов, для которых доступен шаблон |
|
createTime |
Дата и время создания шаблона |
|
updateTime |
Дата и время последнего обновления шаблона |
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "Empty required fields: numeratorId"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Could not find value for parameter |
Не передан обязательный параметр |
|
|
Invalid value {...} to match with parameter {fields}. Should be value of type array. |
Параметр |
|
|
Empty required fields: name, numeratorId, region, entityTypeId |
Не переданы обязательные поля в объекте |
|
|
Missing file content |
Не передан файл шаблона в |
|
|
Could not save file |
Не удалось сохранить файл шаблона |
|
|
You do not have permissions to modify templates |
Недостаточно прав для изменения шаблонов генератора документов |
|
|
Module documentgenerator is not installed |
Модуль |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Изменить существующий шаблон документа crm.documentgenerator.template.update
- Получить информацию о шаблоне документа по Id crm.documentgenerator.template.get
- Получить список шаблонов документов crm.documentgenerator.template.list
- Удалить шаблон документа crm.documentgenerator.template.delete
- Получить поля шаблона документа crm.documentgenerator.template.getfields
- Как добавить шаблон и создать документ на его основе