Update Existing Document Template crm.documentgenerator.template.update
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:
crmWho can execute the method: a user with "modify" access permission for document generator templates
The method crm.documentgenerator.template.update updates an existing document template.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the template |
|
fields* |
Object with template fields to update (more details) |
Parameter fields
|
Name |
Description |
|
name |
Template name |
|
file |
Template file in the format |
|
numeratorId |
Identifier of the numerator. A list of available numerators can be obtained using the method crm.documentgenerator.numerator.list |
|
region |
Template region, for example |
|
entityTypeId |
Array of CRM object identifiers for which the template is available. Typical values:
For objects with directions, a direction suffix is added, for example:
For SPAs, specify
|
|
users |
Array of access permission codes, for example Supported access codes:
|
|
active |
Template activity: |
|
withStamps |
Include stamp and signature: |
|
sort |
Sorting index |
Code Examples
How to Use Examples in Documentation
Example of updating a document template where:
- template identifier —
41 - new name —
Template from file (updated) - numerator identifier —
49 - template region —
ru - CRM object identifier —
2 - access permission code —
UA
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":41,"fields":{"name":"Template from file (updated)","file":["template-updated.docx","**base64_encoded_content**"],"numeratorId":49,"region":"de","entityTypeId":["2"],"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.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":41,"fields":{"name":"Template from file (updated)","file":["template-updated.docx","**base64_encoded_content**"],"numeratorId":49,"region":"de","entityTypeId":["2"],"users":["UA"],"active":"Y","withStamps":"N","sort":500},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.documentgenerator.template.update
// 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 UpdateTemplateResult = {
template: {
id: string
name: string
region: string
code: string | null
download: string
downloadMachine: string
active: 'Y' | 'N'
moduleId: string
numeratorId: string
withStamps: 'Y' | 'N'
users: Record<string, string>
isDeleted: 'Y' | 'N'
sort: string
entityTypeId: string[]
createTime: ISODate
updateTime: ISODate
}
}
try {
const response = await $b24.actions.v2.call.make<UpdateTemplateResult>({
method: 'crm.documentgenerator.template.update',
params: {
id: 41,
fields: {
name: 'Template from file (updated)',
file: ['template-updated.docx', '**base64_encoded_content**'],
numeratorId: 49,
region: 'de',
entityTypeId: ['2'],
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, result.template.updateTime)
}
} 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 updateTemplate() {
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.update',
params: {
id: 41,
fields: {
name: 'Template from file (updated)',
file: ['template-updated.docx', '**base64_encoded_content**'],
numeratorId: 49,
region: 'de',
entityTypeId: ['2'],
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, result.template.updateTime)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateTemplate)
</script>
try {
$response = $b24Service
->core
->call(
'crm.documentgenerator.template.update',
[
'id' => 41,
'fields' => [
'name' => 'Template from file (updated)',
'file' => [
'template-updated.docx',
'**base64_encoded_content**',
],
'numeratorId' => 49,
'region' => 'de',
'entityTypeId' => ['2'],
'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 updating template: ' . $e->getMessage();
}
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.documentgenerator.template.update(
bitrix_id=41,
fields={
"name": "Template from file (updated)",
"file": ["template-updated.docx", "**base64_encoded_content**"],
"numeratorId": 49,
"region": "de",
"entityTypeId": ["2"],
"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}")
BX24.callMethod(
'crm.documentgenerator.template.update',
{
id: 41,
fields: {
name: 'Template from file (updated)',
file: ['template-updated.docx', '**base64_encoded_content**'],
numeratorId: 49,
region: 'de',
entityTypeId: ['2'],
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.update',
[
'id' => 41,
'fields' => [
'name' => 'Template from file (updated)',
'file' => [
'template-updated.docx',
'**base64_encoded_content**',
],
'numeratorId' => 49,
'region' => 'de',
'entityTypeId' => ['2'],
'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 (updated)",
"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-18T17:26:29+03:00"
}
},
"time": {
"start": 1773843989,
"finish": 1773843989.201709,
"duration": 0.20170903205871582,
"processing": 0,
"date_start": "2026-03-18T17:26:29+03:00",
"date_finish": "2026-03-18T17:26:29+03:00",
"operating_reset_at": 1773844589,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response. Contains the object |
|
time |
Information about the request execution time |
Template Type
|
Name |
Description |
|
id |
Identifier of the template |
|
name |
Template name |
|
region |
Template region |
|
Symbolic code of the template |
|
|
download |
Link to download the template file |
|
downloadMachine |
Link to download the template file for the application |
|
active |
Template activity: |
|
moduleId |
Module identifier |
|
numeratorId |
The identifier of the numerator |
|
withStamps |
Include stamp and signature: |
|
users |
Object of access permission codes in the format |
|
isDeleted |
Template deletion flag: |
|
sort |
Sorting index |
|
entityTypeId |
Array of CRM object identifiers for which the template is available |
|
createTime |
Date and time of template creation |
|
updateTime |
Date and time of the last template update |
Error Handling
HTTP status: 400
{
"error": "0",
"error_description": "Template not found"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
Could not find value for parameter |
Required parameter |
|
|
Invalid value {...} to match with parameter {fields}. Should be value of type array. |
Parameter |
|
|
Template not found |
Template with the specified |
|
|
Could not save file |
Failed to save the template file |
|
|
Access denied |
No access to the template |
|
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 |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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
- Add a New Template crm.documentgenerator.template.add
- Get Information About Document Template by Id crm.documentgenerator.template.get
- Get a List of Document Templates crm.documentgenerator.template.list
- Delete Document Template crm.documentgenerator.template.delete
- Get crm.documentgenerator.template.getfields Document Template Fields
- How to Add a Template and Create a Document Based on It