Register a Template in the Site Creation Wizard landing.demos.register

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: landing

Who can execute the method: user with View access permission in the Sites section

The method landing.demos.register registers a custom template in the site and page creation wizard.

The method updates the template if it already exists with the same code for the current application. If it does not exist, it creates a new one.

Method Parameters

Required parameters are marked with *

Name
type

Description

data^*
object | array

Template data.

Typically, the result of the method landing.site.fullExport is passed.

The method accepts both the site export with items and an array of individual template elements more details

params
object

Additional registration parameters more details

Type data

Required parameters are marked with *

Name `type`	Description
charset `string`	Encoding of the exported template
code^* `string`	External code of the template
site_code `string`	Site code (path)
name `string`	Template name
description `string` \| `null`	Template description
type `string`	Template type. Possible values: `page` — templates for pages `store` — templates for stores `knowledge` — templates for knowledge bases `group` — templates for groups `mainpage` — templates for main pages
tpl_type `string`	Template usage type in the wizard. Possible values: `S` — site template `P` — page template
fields `object`	Site fields from the export more details
folders `array` \| `object`	Folders from the export more details
items `object`	Map of template pages in the format `{ "page_code": items }` more details
layout `array` \| `object`	Layout data from the export more details
preview `string`	Link to preview 1x
preview2x `string`	Link to preview 2x
preview3x `string`	Link to preview 3x
preview_url `string`	Link to preview
show_in_list `string`	Indicator for display in the list (`Y`/`N`)
syspages `array` \| `object`	System pages from the export more details
version `integer`	Version of the export format

Type of data.items element

Required parameters are marked with *

Name `type`	Description
old_id `string` \| `integer`	Original page identifier
code^* `string`	External page code
name `string`	Page name
description `string` \| `null`	Page description
type `string`	Page type. Possible values: `page` — templates for pages `store` — templates for stores `knowledge` — templates for knowledge bases `group` — templates for groups `mainpage` — templates for main pages
tpl_type `string`	Template usage type in the wizard. Possible values: `S` — site template `P` — page template
version `integer`	Version of the page format
fields `object`	Page fields from the export more details. Codes for `fields.ADDITIONAL_FIELDS` can be found in the section Additional Page Fields
layout `array` \| `object`	Page layout from the export more details
items `object` \| `array`	Page blocks more details
preview `string`	Link to preview 1x
preview2x `string`	Link to preview 2x
preview3x `string`	Link to preview 3x
preview_url `string`	Link to preview
show_in_list `string`	Indicator for display in the list (`Y`/`N`)

Type of data.items.items element

Name `type`	Description
code `string`	Block code
access `string`	Access level to the block
anchor `string`	Block anchor
old_id `integer`	Original block identifier
cards `object`	Block cards
nodes `object`	Block nodes
style `object`	Block styles
attrs `object`	Block attributes

Parameter params

Name `type`	Description
site_template_id `string`	Identifier of the site template of the main module. Used in on-premise versions
lang `object`	Localization of the main phrases of the template. Details in the article Template Localization
lang_original `string`	Code of the original language for the `lang` array

Code Examples

How to Use Examples in Documentation

Example of registering a template where:

data — structure of the template for registration
data in the examples is obtained in advance using the method landing.site.fullExport

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "data": {
              "charset": "UTF-8",
              "code": "ftmlt",
              "site_code": "/ftmlt/",
              "name": "Business",
              "description": null,
              "type": "page",
              "fields": {
                "TITLE": "Business",
                "LANDING_ID_INDEX": "0",
                "LANDING_ID_404": "0",
                "ADDITIONAL_FIELDS": {}
              },
              "folders": [],
              "items": {
                "ftmlt": {
                  "old_id": "16",
                  "code": "ftmlt",
                  "name": "Business",
                  "description": null,
                  "preview": "",
                  "preview2x": "",
                  "preview3x": "",
                  "preview_url": "",
                  "show_in_list": "Y",
                  "type": "page",
                  "version": 3,
                  "fields": {
                    "TITLE": "Business"
                  },
                  "layout": [],
                  "items": {}
                }
              },
              "layout": [],
              "preview": "",
              "preview2x": "",
              "preview3x": "",
              "preview_url": "",
              "show_in_list": "Y",
              "syspages": [],
              "version": 3
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.demos.register.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "data": {
              "charset": "UTF-8",
              "code": "ftmlt",
              "site_code": "/ftmlt/",
              "name": "Business",
              "description": null,
              "type": "page",
              "fields": {
                "TITLE": "Business",
                "LANDING_ID_INDEX": "0",
                "LANDING_ID_404": "0",
                "ADDITIONAL_FIELDS": {}
              },
              "folders": [],
              "items": {
                "ftmlt": {
                  "old_id": "16",
                  "code": "ftmlt",
                  "name": "Business",
                  "description": null,
                  "preview": "",
                  "preview2x": "",
                  "preview3x": "",
                  "preview_url": "",
                  "show_in_list": "Y",
                  "type": "page",
                  "version": 3,
                  "fields": {
                    "TITLE": "Business"
                  },
                  "layout": [],
                  "items": {}
                }
              },
              "layout": [],
              "preview": "",
              "preview2x": "",
              "preview3x": "",
              "preview_url": "",
              "show_in_list": "Y",
              "syspages": [],
              "version": 3
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.demos.register.json"

try
        {
        	const data = {
        		charset: 'UTF-8',
        		code: 'ftmlt',
        		site_code: '/ftmlt/',
        		name: 'Business',
        		description: null,
        		type: 'page',
        		fields: {
        			TITLE: 'Business',
        			LANDING_ID_INDEX: '0',
        			LANDING_ID_404: '0',
        			ADDITIONAL_FIELDS: {}
        		},
        		folders: [],
        		items: {
        			ftmlt: {
        				old_id: '16',
        				code: 'ftmlt',
        				name: 'Business',
        				description: null,
        				preview: '',
        				preview2x: '',
        				preview3x: '',
        				preview_url: '',
        				show_in_list: 'Y',
        				type: 'page',
        				version: 3,
        				fields: {
        					TITLE: 'Business'
        				},
        				layout: [],
        				items: {}
        			}
        		},
        		layout: [],
        		preview: '',
        		preview2x: '',
        		preview3x: '',
        		preview_url: '',
        		show_in_list: 'Y',
        		syspages: [],
        		version: 3
        	};
        
        	const response = await $b24.callMethod(
        		'landing.demos.register',
        		{
        			data
        		}
        	);
        
        	console.info(response.getData().result);
        }
        catch (error)
        {
        	console.error(error);
        }

try {
            $data = [
                'charset' => 'UTF-8',
                'code' => 'ftmlt',
                'site_code' => '/ftmlt/',
                'name' => 'Business',
                'description' => null,
                'type' => 'page',
                'fields' => [
                    'TITLE' => 'Business',
                    'LANDING_ID_INDEX' => '0',
                    'LANDING_ID_404' => '0',
                    'ADDITIONAL_FIELDS' => [],
                ],
                'folders' => [],
                'items' => [
                    'ftmlt' => [
                        'old_id' => '16',
                        'code' => 'ftmlt',
                        'name' => 'Business',
                        'description' => null,
                        'preview' => '',
                        'preview2x' => '',
                        'preview3x' => '',
                        'preview_url' => '',
                        'show_in_list' => 'Y',
                        'type' => 'page',
                        'version' => 3,
                        'fields' => [
                            'TITLE' => 'Business',
                        ],
                        'layout' => [],
                        'items' => [],
                    ],
                ],
                'layout' => [],
                'preview' => '',
                'preview2x' => '',
                'preview3x' => '',
                'preview_url' => '',
                'show_in_list' => 'Y',
                'syspages' => [],
                'version' => 3,
            ];
        
            $response = $b24Service
                ->core
                ->call(
                    'landing.demos.register',
                    [
                        'data' => $data,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error registering demo: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.demos.register',
            {
                data: {
                    charset: 'UTF-8',
                    code: 'ftmlt',
                    site_code: '/ftmlt/',
                    name: 'Business',
                    description: null,
                    type: 'page',
                    fields: {
                        TITLE: 'Business',
                        LANDING_ID_INDEX: '0',
                        LANDING_ID_404: '0',
                        ADDITIONAL_FIELDS: {}
                    },
                    folders: [],
                    items: {
                        ftmlt: {
                            old_id: '16',
                            code: 'ftmlt',
                            name: 'Business',
                            description: null,
                            preview: '',
                            preview2x: '',
                            preview3x: '',
                            preview_url: '',
                            show_in_list: 'Y',
                            type: 'page',
                            version: 3,
                            fields: {
                                TITLE: 'Business'
                            },
                            layout: [],
                            items: {}
                        }
                    },
                    layout: [],
                    preview: '',
                    preview2x: '',
                    preview3x: '',
                    preview_url: '',
                    show_in_list: 'Y',
                    syspages: [],
                    version: 3
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $data = [
            'charset' => 'UTF-8',
            'code' => 'ftmlt',
            'site_code' => '/ftmlt/',
            'name' => 'Business',
            'description' => null,
            'type' => 'page',
            'fields' => [
                'TITLE' => 'Business',
                'LANDING_ID_INDEX' => '0',
                'LANDING_ID_404' => '0',
                'ADDITIONAL_FIELDS' => [],
            ],
            'folders' => [],
            'items' => [
                'ftmlt' => [
                    'old_id' => '16',
                    'code' => 'ftmlt',
                    'name' => 'Business',
                    'description' => null,
                    'preview' => '',
                    'preview2x' => '',
                    'preview3x' => '',
                    'preview_url' => '',
                    'show_in_list' => 'Y',
                    'type' => 'page',
                    'version' => 3,
                    'fields' => [
                        'TITLE' => 'Business',
                    ],
                    'layout' => [],
                    'items' => [],
                ],
            ],
            'layout' => [],
            'preview' => '',
            'preview2x' => '',
            'preview3x' => '',
            'preview_url' => '',
            'show_in_list' => 'Y',
            'syspages' => [],
            'version' => 3,
        ];
        
        $result = CRest::call(
            'landing.demos.register',
            [
                'data' => $data,
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Error: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

Response Handling

HTTP Status: 200

{
            "result": [5, 7],
            "time": {
                "start": 1774611129,
                "finish": 1774611129.843163,
                "duration": 0.843163013458252,
                "processing": 0,
                "date_start": "2026-03-27T14:32:09+02:00",
                "date_finish": "2026-03-27T14:32:09+02:00",
                "operating_reset_at": 1774611729,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `integer[]`	Array of identifiers of the templates that were created or updated
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "ERROR_ARGUMENT",
            "error_description": "The value of an argument 'data' has an invalid type",
            "argument": "data"
        }

{
            "error": "REGISTER_ERROR_DATA",
            "error_description": "Data is empty or incorrect"
        }

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

Code	Description	Value
`ERROR_ARGUMENT`	The value of an argument 'data' has an invalid type	Parameter `data` is passed in an incorrect type
`REGISTER_ERROR_DATA`	Data is empty or incorrect	Parameter `data` is empty or invalid
`CONTENT_IS_BAD`	Content is defined as unsafe. Unsafe parts can be identified using the method `landing.repo.checkcontent`	Unsafe content found in the provided template
`BX_EMPTY_REQUIRED`	Required field "External code" is not filled	`data` does not have `code` (external code) for the template/element
`ACCESS_DENIED`	`Access denied!`	Insufficient permissions to call the method

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

Localization

Get a List of Templates for Website Creation

Register a Template in the Site Creation Wizard landing.demos.register

Method ParametersMethod Parameters

Type dataType data

Type of data.items elementType of data.items element

Type of data.items.items elementType of data.items.items element

Parameter paramsParameter params

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

Type data

Type of data.items element

Type of data.items.items element

Parameter params

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning