Add Region documentgenerator.region.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.region.add adds a new custom region.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Region parameters (detailed description)

Parameter fields

Name `type`	Description
title* `string`	Region name
languageId `string`	Language identifier for the region, e.g., `de`
formatDate `string`	Date format
formatDatetime `string`	Date and time format
formatName `string`	Full name template, e.g., `#LAST_NAME# #NAME# #SECOND_NAME#`. List of possible modifiers: `#TITLE#` — salutation `#NAME#` — first name `#LAST_NAME#` — last name `#SECOND_NAME#` — middle name `#NAME_SHORT#` — first letter of the first name with a dot `#LAST_NAME_SHORT#` — first letter of the last name with a dot `#SECOND_NAME_SHORT#` — first letter of the middle name with a dot User Documentation What are modifiers in document templates
phrases `object`	Set of localized phrases for the region in the format `code: text`. The keys of the object are strings and can be defined arbitrarily depending on the template. The values of the keys are also strings. To understand which fields are used in the document template, retrieve their list using the method documentgenerator.template.getfields. This will help determine which template values require their own language phrases. Examples: `TAX_INCLUDED`: `Tax included in the price` `TAX_NOT_INCLUDED`: `Tax not included in the price`

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": {
              "title": "Germany (Custom)",
              "languageId": "de",
              "formatDate": "DD.MM.YYYY",
              "formatDatetime": "DD.MM.YYYY HH:MI:SS",
              "formatName": "#LAST_NAME# #NAME# #SECOND_NAME#",
              "phrases": {
                "TAX_INCLUDED": "Tax included in the price",
                "TAX_NOT_INCLUDED": "Tax not included in the price"
              }
            }
          }' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.region.add

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "fields": {
              "title": "Germany (Custom)",
              "languageId": "de",
              "formatDate": "DD.MM.YYYY",
              "formatDatetime": "DD.MM.YYYY HH:MI:SS",
              "formatName": "#LAST_NAME# #NAME# #SECOND_NAME#",
              "phrases": {
                "TAX_INCLUDED": "Tax included in the price",
                "TAX_NOT_INCLUDED": "Tax not included in the price"
              }
            },
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.region.add

try
        {
            const response = await $b24.callMethod(
                'documentgenerator.region.add',
                {
                    fields: {
                        title: 'Germany (Custom)',
                        languageId: 'de',
                        formatDate: 'DD.MM.YYYY',
                        formatDatetime: 'DD.MM.YYYY HH:MI:SS',
                        formatName: '#LAST_NAME# #NAME# #SECOND_NAME#',
                        phrases: {
                            TAX_INCLUDED: 'Tax included in the price',
                            TAX_NOT_INCLUDED: 'Tax not included in the price'
                        }
                    }
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'documentgenerator.region.add',
                [
                    'fields' => [
                        'title' => 'Germany (Custom)',
                        'languageId' => 'de',
                        'formatDate' => 'DD.MM.YYYY',
                        'formatDatetime' => 'DD.MM.YYYY HH:MI:SS',
                        'formatName' => '#LAST_NAME# #NAME# #SECOND_NAME#',
                        'phrases' => [
                            'TAX_INCLUDED' => 'Tax included in the price',
                            'TAX_NOT_INCLUDED' => 'Tax not included in the price',
                        ],
                    ],
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'documentgenerator.region.add',
            {
                fields: {
                    title: 'Germany (Custom)',
                    languageId: 'de',
                    formatDate: 'DD.MM.YYYY',
                    formatDatetime: 'DD.MM.YYYY HH:MI:SS',
                    formatName: '#LAST_NAME# #NAME# #SECOND_NAME#',
                    phrases: {
                        TAX_INCLUDED: 'Tax included in the price',
                        TAX_NOT_INCLUDED: 'Tax not included in the price'
                    }
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'documentgenerator.region.add',
            [
                'fields' => [
                    'title' => 'Germany (Custom)',
                    'languageId' => 'de',
                    'formatDate' => 'DD.MM.YYYY',
                    'formatDatetime' => 'DD.MM.YYYY HH:MI:SS',
                    'formatName' => '#LAST_NAME# #NAME# #SECOND_NAME#',
                    'phrases' => [
                        'TAX_INCLUDED' => 'Tax included in the price',
                        'TAX_NOT_INCLUDED' => 'Tax not included in the price',
                    ],
                ],
            ]
        );
        
        print_r($result);

Response Handling

HTTP Status: 200

{
            "result": {
                "region": {
                    "id": "1",
                    "title": "Germany (Custom)",
                    "languageId": "de",
                    "formatDate": "DD.MM.YYYY",
                    "formatDatetime": "DD.MM.YYYY HH:MI:SS",
                    "formatName": "#LAST_NAME# #NAME# #SECOND_NAME#",
                    "phrases": {
                        "TAX_INCLUDED": "Tax included in the price",
                        "TAX_NOT_INCLUDED": "Tax not included in the price"
                    }
                }
            },
            "time": {
                "start": 1774431594,
                "finish": 1774431594.911013,
                "duration": 0.9110128879547119,
                "processing": 0,
                "date_start": "2026-03-25T12:39:54+01:00",
                "date_finish": "2026-03-25T12:39:54+01:00",
                "operating_reset_at": 1774432194,
                "operating": 0.23056697845458984
            }
        }

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
region `object`	Region data (detailed description)

Object region

Name `type`	Description
id `string`	Identifier of the custom region
title `string`	Region name
languageId `string`	Language identifier for the region
formatDate `string`	Date format
formatDatetime `string`	Date and time format
formatName `string`	Full name template
phrases `object`	Set of phrases in the format `code: text`, where keys and values are strings. Examples of keys: `TAX_INCLUDED`, `TAX_NOT_INCLUDED` The list of template fields can be obtained using the method documentgenerator.template.getfields

Error Handling

HTTP Status: 400

{
            "error": "100",
            "error_description": "Could not find value for parameter {fields}"
        }

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` is missing or empty
`400`	`BX_EMPTY_REQUIRED`	Required field "TITLE" is not filled	The required field `title` is missing in the `fields` parameter
`400`	`0`	You do not have permissions to modify templates	Insufficient permissions to modify document generator 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

Update Region

Add Region documentgenerator.region.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Object resultObject result

Object regionObject region

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning