Upload Template documentgenerator.template.add

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: documentgenerator

Who can execute the method: a user with permission to modify document generator templates

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

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Set of template fields (detailed description)

Parameter fields

Name `type`	Description
name* `string`	Template name
fileId* `integer`	Identifier of the previously uploaded template file from Drive. You can obtain the file identifier in two ways. Use one of the file upload methods: disk.storage.uploadfile disk.folder.uploadfile Use one of the methods to get the list of files: disk.storage.getchildren disk.folder.getchildren
file* `file`	Template file, if it needs to be uploaded. Used instead of the `fileId` parameter. The file can be passed in three ways: as a base64 string as an array `["file_name.docx","base64_content"]` as a file `multipart/form-data` Typical Use-Cases and Scenarios How to Upload Files
numeratorId* `integer`	Identifier of the numerator. You can obtain the identifier after creating a numerator or by using the method to get the list of numerators
region* `string`	Template region, for example, `de`
code `string`	Symbolic code of the template
users `array`	Users who will have access to the template. Possible values: `U{id}` — user `G{id}` — user group `AU` — all authorized users `UA` — all users `D{id}` — department `DR{id}` — department with sub-departments `SG{id}` — working group or project `SG{id}_A` — owner of the working group or project `SG{id}_E` — moderators of the working group or project `SG{id}_K` — all members of the working group or project If not provided, the current user is automatically added
active `char`	Template activity. Possible values: `Y` — active `N` — inactive Default is `Y`
withStamps `char`	Include stamps and signatures. Possible values: `Y` — yes `N` — no Default is `N`
sort `integer`	Sort index

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"fields":{"name":"SUPPLY_CONTRACT Template","fileId":5641,"numeratorId":1,"region":"de","code":"REST_TEMPLATE","users":["UA"],"active":"Y","withStamps":"N","sort":500}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.template.add

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"fields":{"name":"SUPPLY_CONTRACT Template","fileId":5641,"numeratorId":1,"region":"de","code":"REST_TEMPLATE","users":["UA"],"active":"Y","withStamps":"N","sort":500},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.template.add

try
        {
            const response = await $b24.callMethod(
                'documentgenerator.template.add',
                {
                    fields: {
                        name: 'SUPPLY_CONTRACT Template',
                        fileId: 5641,
                        numeratorId: 1,
                        region: 'de',
                        code: 'REST_TEMPLATE',
                        users: ['UA'],
                        active: 'Y',
                        withStamps: 'N',
                        sort: 500
                    }
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'documentgenerator.template.add',
                [
                    'fields' => [
                        'name' => 'SUPPLY_CONTRACT Template',
                        'fileId' => 5641,
                        'numeratorId' => 1,
                        'region' => 'de',
                        'code' => 'REST_TEMPLATE',
                        'users' => ['UA'],
                        'active' => 'Y',
                        'withStamps' => 'N',
                        'sort' => 500,
                    ],
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'documentgenerator.template.add',
            {
                fields: {
                    name: 'SUPPLY_CONTRACT Template',
                    fileId: 5641,
                    numeratorId: 1,
                    region: 'de',
                    code: 'REST_TEMPLATE',
                    users: ['UA'],
                    active: 'Y',
                    withStamps: 'N',
                    sort: 500
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'documentgenerator.template.add',
            [
                'fields' => [
                    'name' => 'SUPPLY_CONTRACT Template',
                    'fileId' => 5641,
                    'numeratorId' => 1,
                    'region' => 'de',
                    'code' => 'REST_TEMPLATE',
                    'users' => ['UA'],
                    'active' => 'Y',
                    'withStamps' => 'N',
                    'sort' => 500,
                ],
            ]
        );
        
        print_r($result);

Response Handling

HTTP Status: 200

{
            "result": {
                "template": {
                    "id": "57",
                    "name": "SUPPLY_CONTRACT Template",
                    "region": "de",
                    "code": "REST_TEMPLATE",
                    "download": "https://mysite.com/bitrix/services/main/ajax.php?action=documentgenerator.api.template.download&SITE_ID=s1&id=57&ts=0",
                    "active": "Y",
                    "moduleId": "rest",
                    "numeratorId": "1",
                    "withStamps": "N",
                    "providers": {
                        "bitrix\\documentgenerator\\dataprovider\\rest": "bitrix\\documentgenerator\\dataprovider\\rest"
                    },
                    "users": {
                        "UA": "UA"
                    },
                    "isDeleted": "N",
                    "sort": "500",
                    "createTime": "2026-03-23T16:51:25+01:00",
                    "updateTime": "2026-03-23T16:51:25+01:00",
                    "downloadMachine": "https://mysite.com/rest/documentgenerator.api.template.download.json?auth=6d53c1690000071b00000844000001f7f0f1075612a492ef6fe0b4127e521b543e4376&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS50ZW1wbGF0ZS5kb3dubG9hZCZTSVRFX0lEPXMxJmlkPTU3JnRzPTAmXz1IeG56TmtsQklGNjRsQlBkNkNiekNwd1U2bnduQk40Mw%3D%3D%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS50ZW1wbGF0ZS5kb3dubG9hZCZkb2N1bWVudGdlbmVyYXRvcnxZV04wYVc5dVBXUnZZM1Z0Wlc1MFoyVnVaWEpoZEc5eUxtRndhUzUwWlcxd2JHRjBaUzVrYjNkdWJHOWhaQ1pUU1ZSRlgwbEVQWE14Sm1sa1BUVTNKblJ6UFRBbVh6MUllRzU2VG10c1FrbEdOalJzUWxCa05rTmlla053ZDFVMmJuZHVRazQwTXc9PXw2ZDUzYzE2OTAwMDAwNzFiMDAwMDA4NDQwMDAwMDFmN2YwZjEwNzU2MTJhNDkyZWY2ZmUwYjQxMjdlNTIxYjU0M2U0Mzc2Ig%3D%3D.vtTu%2B9Ac%2BT5VgeyDm1jiVBGsmCQagvrqjACd%2BNgDigA%3D"
                }
            },
            "time": {
                "start": 1774273885,
                "finish": 1774273885.843453,
                "duration": 0.8434529304504395,
                "processing": 0,
                "date_start": "2026-03-23T16:51:25+01:00",
                "date_finish": "2026-03-23T16:51:25+01:00",
                "operating_reset_at": 1774274485,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response (detailed description)
time `time`	Information about the request execution time

Object result

Name `type`	Description
template `object`	Template data (detailed description)

Object template

Name `type`	Description
id `string`	Template identifier
name `string`	Template name
region `string`	Template region
code `string`	Symbolic code of the template
download `string`	Link to download the template
downloadMachine `string`	Link to download the template for machine processing
active `char`	Template activity. Possible values: `Y` — active `N` — inactive
moduleId `string`	Module identifier
numeratorId `string`	Identifier of the numerator
withStamps `char`	Use of stamps and signatures. Possible values: `Y` — yes `N` — no
providers `object`	Template data providers. Key and value are equal to the name of the data provider class
users `object`	Access codes to the template. Key and value are equal to the access code
isDeleted `char`	Deletion status of the template. Possible values: `Y` — deleted `N` — not deleted
sort `string`	Sort index
createTime `datetime`	Creation date and time
updateTime `datetime`	Update date and time

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

Status	Code	Description	Value
`400`	`100`	Could not find value for parameter	Required parameter `fields` not provided
`400`	`100`	Invalid value to match with parameter {fields}. Should be value of type array	Parameter `fields` not passed as an object
`400`	`0`	Empty required fields: name, numeratorId, region	Required fields for creating a template not provided: `name`, `numeratorId`, `region`. The error lists the fields that are missing in the request
`400`	`0`	Missing file content	Template file not provided
`400`	`0`	You do not have permissions to modify templates	Insufficient permissions to modify templates

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "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

Overview of Methods

Edit Template

Upload Template documentgenerator.template.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Object resultObject result

Object templateObject template

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning