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

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

JS (TS)

JS (UMD)

Python

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"

// 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 } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<number[]>({
            method: 'landing.demos.register',
            params: {
              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,
              },
            },
            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('Registered template IDs:', result)
          }
        } 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 registerDemo() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'landing.demos.register',
                params: {
                  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,
                  },
                },
                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('Registered template IDs:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', registerDemo)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.landing.demos.register(
                data={
                    "charset": "UTF-8",
                    "code": "ftmlt",
                    "site_code": "/ftmlt/",
                    "name": "Business",
                    "description": None,
                    "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": None,
                            "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
            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 {
            $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>';
        }

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "landing.demos.register", b24.Params{
        	"data": b24.Params{
        		"charset":     "UTF-8",
        		"code":        "ftmlt",
        		"site_code":   "/ftmlt/",
        		"name":        "Business",
        		"description": nil,
        		"type":        "page",
        		"fields": b24.Params{
        			"TITLE":             "Business",
        			"LANDING_ID_INDEX":  "0",
        			"LANDING_ID_404":    "0",
        			"ADDITIONAL_FIELDS": b24.Params{},
        		},
        		"folders": []any{},
        		"items": b24.Params{
        			"ftmlt": b24.Params{
        				"old_id":       "16",
        				"code":         "ftmlt",
        				"name":         "Business",
        				"description":  nil,
        				"preview":      "",
        				"preview2x":    "",
        				"preview3x":    "",
        				"preview_url":  "",
        				"show_in_list": "Y",
        				"type":         "page",
        				"version":      3,
        				"fields": b24.Params{
        					"TITLE": "Business",
        				},
        				"layout": []any{},
        				"items":  b24.Params{},
        			},
        		},
        		"layout":       []any{},
        		"preview":      "",
        		"preview2x":    "",
        		"preview3x":    "",
        		"preview_url":  "",
        		"show_in_list": "Y",
        		"syspages":     []any{},
        		"version":      3,
        	},
        })
        if err != nil {
        	return fmt.Errorf("landing.demos.register: %w", err)
        }
        
        var items []b24.ID
        if err := json.Unmarshal(res.Result, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("received:", len(items))

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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

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: 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 Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	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
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	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 — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not 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
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	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 `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	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

Continue Learning

Was the article helpful?

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

Was the article helpful?

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