Add a New Template crm.documentgenerator.template.add

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: crm

Who can execute the method: a user with "modify" access permission for document generator templates

The method crm.documentgenerator.template.add adds a new document template.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

Object with template parameters (more details)

Parameter fields

Required parameters are marked with *

Name
type

Description

name*
string

Template name

file*
file

Template file in the format ["file_name.docx", "base64_content"]. Can be sent in base64 or multipart/form-data. More details: How to Upload Files

numeratorId*
integer

Identifier of the numerator. A list of available numerators can be obtained using the method crm.documentgenerator.numerator.list

region*
string

Template region, for example ru

entityTypeId*
array

Array of CRM object identifiers for which the template is available.

Typical values:

  • 1 — lead
  • 2 — deal
  • 3 — contact
  • 4 — company
  • 5 — invoice (old version)
  • 7 — estimate
  • 31 — invoice

For objects with pipelines, a pipeline suffix is added, for example:

  • 2_category_0 — deal, pipeline 0
  • 31_1 — invoice, pipeline 1

For SPAs, specify entityTypeId of the type from crm.type.list or crm.enum.ownertype, for example:

  • 177 — SPA element with entityTypeId = 177
  • 177_1 — SPA element with pipeline 1

users
array

Array of access permission codes, for example ["UA"]

Supported access codes:

  • UA — all users
  • U<id> — user
  • G<id> — user group
  • D<id> — department
  • DR<id> — department with sub-departments
  • IU<id> — intranet user
  • SG<id>, SG<id>_A, SG<id>_E, SG<id>_K — workgroup/project
  • SU<id>, SU<id>_M — social network user
  • CHAT<id> — chat
  • AD, AE, AT, ATD, ATE, ATT (and variants with identifier) — role in the structure
  • SND<id>, SNDR<id>, SNT<id>, SNTR<id> — structural codes of departments and teams

If the parameter is not provided or is empty, the current user (U<id>) is automatically added to access permissions

active
char

Template activity: Y or N. Default is Y

withStamps
char

Include stamp and signature: Y or N. Default is N

sort
integer

Sorting index

Code Examples

How to Use Examples in Documentation

Example of adding a document template where:

  • template name — REST Proposal Template
  • numerator identifier — 49
  • template region — ru
  • CRM object identifiers — 2 and 2_category_0
  • access permission code — UA
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"name":"REST Proposal Template","file":["template.docx","**base64_encoded_content**"],"numeratorId":49,"region":"de","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 Proposal Template","file":["template.docx","**base64_encoded_content**"],"numeratorId":49,"region":"de","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: 'de',
                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: 'de',
                    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 Proposal Template",
                    "file": ["template.docx", "**base64_encoded_content**"],
                    "numeratorId": 49,
                    "region": "de",
                    "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 Error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK Error: {error.message}")
        except Exception as error:
            print(f"Unexpected Error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.template.add',
                    [
                        'fields' => [
                            'name' => 'REST Proposal Template',
                            'file' => [
                                'template.docx',
                                '**base64_encoded_content**',
                            ],
                            'numeratorId' => 49,
                            'region' => 'de',
                            '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 Proposal Template',
                    file: ['template.docx', '**base64_encoded_content**'],
                    numeratorId: 49,
                    region: 'de',
                    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 Proposal Template',
                    'file' => [
                        'template.docx',
                        '**base64_encoded_content**',
                    ],
                    'numeratorId' => 49,
                    'region' => 'de',
                    'entityTypeId' => ['2', '2_category_0'],
                    'users' => ['UA'],
                    'active' => 'Y',
                    'withStamps' => 'N',
                    'sort' => 500,
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.documentgenerator.template.add", b24.Params{
        	"fields": b24.Params{
        		"name":         "REST Proposal Template",
        		"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)
        }
        
        // The method wraps the response in an object with the "template" key.
        raw, ok := b24.Unwrap(res.Result, "template")
        if !ok {
        	return fmt.Errorf("no template key in the response")
        }
        
        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("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Name)
        

Response Handling

HTTP status: 200

{
            "result": {
                "template": {
                    "id": "41",
                    "name": "Template from file",
                    "region": "de",
                    "code": null,
                    "download": "https://mysite.com/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.com/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
            }
        }
        

Returned Data

Name
type

Description

result
object

Root element of the response. Contains the object template

time
time

Information about the request execution time

Template Type

Name
type

Description

id
string

Identifier of the template

name
string

Template name

region
string

Template region

code
string | null

Symbolic code of the template

download
string

Link to download the template file

downloadMachine
string

Link to download the template file for the application

active
char

Template activity: Y or N

moduleId
string

Module identifier

numeratorId
string

The identifier of the numerator

withStamps
char

Include stamp and signature: Y or N

users
object

Object of access permission codes in the format {"UA":"UA"}

isDeleted
char

Template deletion flag: Y or N

sort
string

Sorting index

entityTypeId
array

Array of CRM object identifiers for which the template is available

createTime
datetime

Date and time of template creation

updateTime
datetime

Date and time of the last template update

Error Handling

HTTP status: 400

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

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Value

100

Could not find value for parameter

Required parameter fields not provided

100

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

Parameter fields not provided as an object

0

Empty required fields: name, numeratorId, region, entityTypeId

Required fields not provided in the fields object

0

Missing file content

Template file not provided in fields.file

0

Could not save file

Failed to save the template file

Empty value

You do not have permissions to modify templates

Insufficient permissions to modify document generator templates

Empty value

Module documentgenerator is not installed

The documentgenerator module is not available

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

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

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning