Add a New Template crm.documentgenerator.template.add

Scope: crm

Who can execute the method: user with "edit" 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 `de`
entityTypeId^* `array`	Array of CRM entity 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 directions, a direction suffix is added, for example: `2_category_0` — deal, direction `0` `31_1` — invoice, direction `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 direction `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`	Sort index

Code Examples

How to Use Examples in Documentation

Example of adding a document template where:

template name — Estimate Template from REST
numerator identifier — 49
template region — de
CRM entity identifiers — 2 and 2_category_0
access permission code — UA

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"name":"Estimate Template 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}}' \
        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":"Estimate Template 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},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.documentgenerator.template.add

try
        {
        	const response = await $b24.callMethod(
        		'crm.documentgenerator.template.add',
        		{
        			fields: {
        				name: 'Estimate Template 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,
        			},
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.template.add',
                    [
                        'fields' => [
                            'name' => 'Estimate Template 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,
                        ],
                    ]
                );
        
            $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: 'Estimate Template 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,
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.documentgenerator.template.add',
            [
                'fields' => [
                    'name' => 'Estimate Template 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,
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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+02:00",
                    "updateTime": "2026-03-18T15:54:20+02:00"
                }
            },
            "time": {
                "start": 1773838459,
                "finish": 1773838460.813945,
                "duration": 1.8139450550079346,
                "processing": 1,
                "date_start": "2026-03-18T15:54:19+02:00",
                "date_finish": "2026-03-18T15:54:20+02: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

Type template

Name `type`	Description
id `string`	Template identifier
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`	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`	Sort index
entityTypeId `array`	Array of CRM entity 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 may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

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 unavailable

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Modify Existing Document Template

Add a New Template crm.documentgenerator.template.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Type templateType template

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning