Update Template 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: documentgenerator

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

The method documentgenerator.template.update updates an existing template.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Template identifier.

You can obtain the template identifier after creating a template or by using the method to retrieve the list of templates

fields*
object

Template fields to update (detailed description)

Parameter fields

Name
type

Description

name
string

Template name

file
file

New template file. It 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

numeratorId
integer

Identifier of the numerator

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

providers
array

List of data providers

active
char

Activity status. Possible values:

  • Y — active
  • N — inactive

withStamps
char

Include stamps and signatures. Possible values:

  • Y — yes
  • N — no

sort
integer

Sort index

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"id":57,"fields":{"name":"SUPPLY_CONTRACT_NEW Template","numeratorId":3,"code":"REST_TEMPLATE","users":["U503"],"sort":700}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.template.update
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"id":57,"fields":{"name":"SUPPLY_CONTRACT_NEW Template","numeratorId":3,"code":"REST_TEMPLATE","users":["U503"],"sort":700},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.template.update
        
try
        {
            const response = await $b24.callMethod(
                'documentgenerator.template.update',
                {
                    id: 57,
                    fields: {
                        name: 'SUPPLY_CONTRACT_NEW Template',
                        numeratorId: 3,
                        code: 'REST_TEMPLATE',
                        users: ['U503'],
                        sort: 700
                    }
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }
        
try {
            $response = $b24Service->core->call(
                'documentgenerator.template.update',
                [
                    'id' => 57,
                    'fields' => [
                        'name' => 'SUPPLY_CONTRACT_NEW Template',
                        'numeratorId' => 3,
                        'code' => 'REST_TEMPLATE',
                        'users' => ['U503'],
                        'sort' => 700,
                    ],
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
BX24.callMethod(
            'documentgenerator.template.update',
            {
                id: 57,
                fields: {
                    name: 'SUPPLY_CONTRACT_NEW Template',
                    numeratorId: 3,
                    code: 'REST_TEMPLATE',
                    users: ['U503'],
                    sort: 700
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'documentgenerator.template.update',
            [
                'id' => 57,
                'fields' => [
                    'name' => 'SUPPLY_CONTRACT_NEW Template',
                    'numeratorId' => 3,
                    'code' => 'REST_TEMPLATE',
                    'users' => ['U503'],
                    'sort' => 700,
                ],
            ]
        );
        
        print_r($result);

Response Handling

HTTP Status: 200

{
            "result": {
                "template": {
                    "id": "57",
                    "name": "SUPPLY_CONTRACT_NEW 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": "3",
                    "withStamps": "N",
                    "providers": {
                        "bitrix\\documentgenerator\\dataprovider\\rest": "bitrix\\documentgenerator\\dataprovider\\rest"
                    },
                    "users": {
                        "U503": "U503"
                    },
                    "isDeleted": "N",
                    "sort": "700",
                    "createTime": "2026-03-23T16:51:25+02:00",
                    "updateTime": "2026-03-23T17:26:39+02:00",
                    "downloadMachine": "https://mysite.com/rest/documentgenerator.api.template.download.json?auth=6d53c1690000071b00000844000001f7f0f1075612a492ef6fe0b4127e521b543e4376&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS50ZW1wbGF0ZS5kb3dubG9hZCZTSVRFX0lEPXMxJmlkPTU3JnRzPTAmXz1UdDBpNDBOU2hvQkxtN1Y5VmhEZm1MbTU2ZmQ0d3puNA%3D%3D%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS50ZW1wbGF0ZS5kb3dubG9hZHxkb2N1bWVudGdlbmVyYXRvcnxZV04wYVc5dVBXUnZZM1Z0Wlc1MFoyVnVaWEpoZEc5eUxtRndhUzUwWlcxd2JHRjBaUzVrYjNkdWJHOWhaQ1pUU1ZSRlgwbEVQWE14Sm1sa1BUVTNKblJ6UFRBbVh6MVVkREJwTkRCT1UyaHZRa3h0TjFZNVZtaEVabTFNYlRVMlptUTBkM3B1TkE9PXw2ZDUzYzE2OTAwMDAwNzFiMDAwMDA4NDQwMDAwMDFmN2YwZjEwNzU2MTJhNDkyZWY2ZmUwYjQxMjdlNTIxYjU0M2U0Mzc2Ig%3D%3D.6kAmDGdiQCSZI%2Bcm%2Fg86RUqVH5dMvSDxHbx20yjOYK4%3D"
                }
            },
            "time": {
                "start": 1774275999,
                "finish": 1774275999.631086,
                "duration": 0.6310861110687256,
                "processing": 0,
                "date_start": "2026-03-23T17:26:39+02:00",
                "date_finish": "2026-03-23T17:26:39+02:00",
                "operating_reset_at": 1774276599,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
object

Root element of the response (detailed description)

time
time

Information about the execution time of the request

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 status. 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

Data providers of the template.

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

Date and time of creation

updateTime
datetime

Date and time of update

Error Handling

HTTP Status: 400

{
            "error": "0",
            "error_description": "Template not found"
        }

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

Bitrix\DocumentGenerator\Template constructor must be public

Required parameter id not provided

400

100

Could not find value for parameter

Required parameter fields not provided

400

0

Template not found

Template with the specified id not found

400

0

You do not have permissions to modify this template

Insufficient rights to modify the specified template

400

0

You do not have permissions to modify templates

Insufficient rights 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

Previous
Upload Template
Next
Get Template by ID