Upload Template 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:
documentgeneratorWho 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 |
Description |
|
fields* |
Set of template fields (detailed description) |
Parameter fields
|
Name |
Description |
|
name* |
Template name |
|
fileId* |
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: Use one of the methods to get the list of files: |
|
file* |
Template file, if it needs to be uploaded. Used instead of the The file can be passed in three ways:
Typical Use-Cases and Scenarios |
|
numeratorId* |
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* |
Template region, for example, |
|
code |
Symbolic code of the template |
|
users |
Users who will have access to the template. Possible values:
If not provided, the current user is automatically added |
|
active |
Template activity. Possible values:
Default is |
|
withStamps |
Include stamps and signatures. Possible values:
Default is |
|
sort |
Sort index |
Code Examples
How to Use Examples in Documentation
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
// 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
download: string
downloadMachine: string
active: 'Y' | 'N'
moduleId: string
numeratorId: string
withStamps: 'Y' | 'N'
providers: Record<string, string>
users: Record<string, string>
isDeleted: 'Y' | 'N'
sort: string
createTime: ISODate
updateTime: ISODate
}
}
try {
const response = await $b24.actions.v2.call.make<TemplateAddResult>({
method: 'documentgenerator.template.add',
params: {
fields: {
name: 'SUPPLY_CONTRACT Template',
fileId: 5641,
numeratorId: 1,
region: 'ru',
code: 'REST_TEMPLATE',
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('Added template:', 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: 'documentgenerator.template.add',
params: {
fields: {
name: 'SUPPLY_CONTRACT Template',
fileId: 5641,
numeratorId: 1,
region: 'ru',
code: 'REST_TEMPLATE',
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('Added template:', 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
template_fields = {
"name": "SUPPLY_CONTRACT Template",
"fileId": 5641,
"numeratorId": 1,
"region": "ru",
"code": "REST_TEMPLATE",
"users": [
"UA",
],
"active": "Y",
"withStamps": "N",
"sort": 500,
}
try:
bitrix_response = client.documentgenerator.template.add(
fields=template_fields,
).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(
'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);
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "documentgenerator.template.add", b24.Params{
"fields": b24.Params{
"name": "SUPPLY_CONTRACT Template",
"fileId": 5641,
"numeratorId": 1,
"region": "ru",
"code": "REST_TEMPLATE",
"users": []string{"UA"},
"active": "Y",
"withStamps": "N",
"sort": 500,
},
})
if err != nil {
return fmt.Errorf("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"`
Code string `json:"code"`
Download string `json:"download"`
Active string `json:"active"`
}
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": "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 |
Description |
|
result |
Root element of the response (detailed description) |
|
time |
Information about the request execution time |
Object result
|
Name |
Description |
|
template |
Template data (detailed description) |
Object template
|
Name |
Description |
|
id |
Template identifier |
|
name |
Template name |
|
region |
Template region |
|
code |
Symbolic code of the template |
|
download |
Link to download the template |
|
downloadMachine |
Link to download the template for machine processing |
|
active |
Template activity. Possible values:
|
|
moduleId |
Module identifier |
|
numeratorId |
Identifier of the numerator |
|
withStamps |
Use of stamps and signatures. Possible values:
|
|
providers |
Template data providers. Key and value are equal to the name of the data provider class |
|
users |
Access codes to the template. Key and value are equal to the access code |
|
isDeleted |
Deletion status of the template. Possible values:
|
|
sort |
Sort index |
|
createTime |
Creation date and time |
|
updateTime |
Update date and time |
Error Handling
HTTP Status: 400
{
"error": "0",
"error_description": "Empty required fields: numeratorId"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Could not find value for parameter |
Required parameter |
|
|
|
Invalid value to match with parameter {fields}. Should be value of type array |
Parameter |
|
|
|
Empty required fields: name, numeratorId, region |
Required fields for creating a template not provided: |
|
|
|
Missing file content |
Template file not provided |
|
|
|
You do not have permissions to modify templates |
Insufficient permissions to modify templates |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |