Добавить новый шаблон crm.documentgenerator.template.add

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: пользователь с правом "изменения" шаблонов генератора документов

Метод crm.documentgenerator.template.add добавляет новый шаблон документа.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

fields*
object

Объект с параметрами шаблона (подробнее)

Параметр fields

Обязательные параметры отмечены *

Название
тип

Описание

name*
string

Название шаблона

file*
file

Файл шаблона в формате ["имя_файла.docx", "base64_контент"]. Можно передать в base64 или в multipart/form-data. Подробнее: Как загружать файлы

numeratorId*
integer

Идентификатор нумератора. Список доступных нумераторов можно получить методом crm.documentgenerator.numerator.list

region*
string

Регион шаблона, например ru

entityTypeId*
array

Массив идентификаторов CRM-объектов, для которых доступен шаблон.

Типичные значения:

  • 1 — лид
  • 2 — сделка
  • 3 — контакт
  • 4 — компания
  • 5 — счет (старая версия)
  • 7 — коммерческое предложение
  • 31 — счет

Для объектов с воронками добавляется суффикс воронки, например:

  • 2_category_0 — сделка, воронка 0
  • 31_1 — счет, воронка 1

Для смарт-процессов указывается entityTypeId типа из crm.type.list или crm.enum.ownertype, например:

  • 177 — элемент смарт-процесса с entityTypeId = 177
  • 177_1 — элемент смарт-процесса с воронкой 1

users
array

Массив кодов прав доступа, например ["UA"]

Поддерживаются коды доступа:

  • UA — все пользователи
  • U<id> — пользователь
  • G<id> — группа пользователей
  • D<id> — отдел
  • DR<id> — отдел с подотделами
  • IU<id> — пользователь интранета
  • SG<id>, SG<id>_A, SG<id>_E, SG<id>_K — рабочая группа/проект
  • SU<id>, SU<id>_M — пользователь соцсети
  • CHAT<id> — чат
  • AD, AE, AT, ATD, ATE, ATT (и варианты с идентификатором) — роль в структуре
  • SND<id>, SNDR<id>, SNT<id>, SNTR<id> — структурные коды подразделений и команд

Если параметр не передан или передан пустым, в доступ автоматически добавляется текущий пользователь (U<id>)

active
char

Активность шаблона: Y или N. По умолчанию Y

withStamps
char

Подставлять печать и подпись: Y или N. По умолчанию N

sort
integer

Индекс сортировки

Примеры кода

Как использовать примеры в документации

Пример добавления шаблона документа, где:

  • название шаблона — Шаблон КП из 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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

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}")
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();
}
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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.documentgenerator.template.add", b24.Params{
	"fields": b24.Params{
		"name":         "Шаблон КП из REST",
		"file":         []string{"template.docx", "**base64_encoded_content**"},
		"numeratorId":  49,
		"region":       "ru",
		"entityTypeId": []string{"2", "2_category_0"},
		"users":        []string{"UA"},
		"active":       "Y",
		"withStamps":   "N",
		"sort":         500,
	},
})
if err != nil {
	return fmt.Errorf("crm.documentgenerator.template.add: %w", err)
}

// Метод заворачивает ответ в объект с ключом "template".
raw, ok := b24.Unwrap(res.Result, "template")
if !ok {
	return fmt.Errorf("в ответе нет ключа template")
}

var item struct {
	ID       b24.ID `json:"id"`
	Name     string `json:"name"`
	Region   string `json:"region"`
	Download string `json:"download"`
	Active   string `json:"active"`
	ModuleID string `json:"moduleId"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Name)

Обработка ответа

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
object

Корневой элемент ответа. Содержит объект template

time
time

Информация о времени выполнения запроса

Тип template

Название
тип

Описание

id
string

Идентификатор шаблона

name
string

Название шаблона

region
string

Регион шаблона

code
string | null

Символьный код шаблона

download
string

Ссылка на скачивание файла шаблона

downloadMachine
string

Ссылка на скачивание файла шаблона для приложения

active
char

Активность шаблона: Y или N

moduleId
string

Идентификатор модуля

numeratorId
string

Идентификатор нумератора

withStamps
char

Подставлять печать и подпись: Y или N

users
object

Объект кодов прав доступа в формате {"UA":"UA"}

isDeleted
char

Признак удаления шаблона: Y или N

sort
string

Индекс сортировки

entityTypeId
array

Массив идентификаторов CRM-элементов, для которых доступен шаблон

createTime
datetime

Дата и время создания шаблона

updateTime
datetime

Дата и время последнего обновления шаблона

Обработка ошибок

HTTP-статус: 400

{
    "error": "0",
    "error_description": "Empty required fields: numeratorId"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Код

Описание

Значение

100

Could not find value for parameter

Не передан обязательный параметр fields

100

Invalid value {...} to match with parameter {fields}. Should be value of type array.

Параметр fields передан не как объект

0

Empty required fields: name, numeratorId, region, entityTypeId

Не переданы обязательные поля в объекте fields

0

Missing file content

Не передан файл шаблона в fields.file

0

Could not save file

Не удалось сохранить файл шаблона

Пустое значение

You do not have permissions to modify templates

Недостаточно прав для изменения шаблонов генератора документов

Пустое значение

Module documentgenerator is not installed

Модуль documentgenerator недоступен

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение