Add Page by Template landing.landing.addByTemplate

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: a user with "edit" access permission for the site

The method landing.landing.addByTemplate creates a page in the specified site based on the template code and returns the identifier of the created page. The new page is created as inactive (ACTIVE = N).

If you need to fully manage the fields of the created page, use landing.landing.add.

Method Parameters

Required parameters are marked with *

Name `type`	Description
scope `string`	Internal scope of landings. It is not related to the REST scope `landing` in the method name. The value of `scope` must correspond to the type of site (detailed description)
siteId* `integer`	Identifier of the site where the page needs to be created. The site identifier can be obtained using the landing.site.getList method or from the result of the landing.site.add method
code* `string`	Template code for the page. A list of available templates can be obtained using the landing.demos.getPageList method. The code depends on the templates available in Bitrix24. For example, the value might look like `krayt.monotovar@KraytPetShop`
fields `object`	Additional parameters for creating the page (detailed description)

Parameter fields

Required parameters are marked with *

Name `type`	Description
TITLE `string`	Overrides the title of the created page and the SEO titles of the template. If not provided, values from the template will be used
DESCRIPTION `string`	Overrides the SEO descriptions of the template. The value is recorded in the additional fields `METAOG_DESCRIPTION` and `METAMAIN_DESCRIPTION`, but not in the `DESCRIPTION` field of the page itself
ID `integer`	Identifier of an existing page or folder in the same site. If a folder is provided, the new page will be created within it. If a page from a folder is provided, the new page will be created in the same folder. For an item without a folder, the method will take the value from `fields.FOLDER_ID`, if this parameter is specified. If an active item is provided, the new page will be published automatically after creation. If `ID` points to a folder or an item with a filled `FOLDER_ID`, the `fields.FOLDER_ID` parameter is ignored. The page identifier can be obtained using the landing.landing.getList method, and the folder identifier can be obtained using the landing.site.getFolders method
FOLDER_ID `integer`	Identifier of the folder where the page needs to be created. The folder must belong to the same site as `siteId`, otherwise the method will return an error. The folder identifier can be obtained using the landing.site.getFolders method. This parameter is used if the creation folder is not determined by `fields.ID`
SITE_TYPE `string`	Type of templates from which the page is created. Site types from the article Working with Site Types and Scopes are used. If not provided, the site type is taken. For sites of types `STORE` and `SMN`, the default value is `PAGE`
PREPARE_BLOCKS `boolean`	Enables preparation of template blocks when creating the page. Works only together with `PREPARE_BLOCKS_DATA`. Pass boolean `true`
PREPARE_BLOCKS_DATA `object`	Additional data for preparing template blocks when creating the page. In `PREPARE_BLOCKS_DATA`, first specify the block code from the page template, and inside - parameters for this block (detailed description)
ADD_IN_MENU `string`	Flag for adding the created page to the site menu. Supported values are `Y` and `N`. The logic triggers only when the value is `Y`, if the page is not already added to the menu through `BLOCK_ID` and `MENU_CODE`, and if `TITLE` is provided
BLOCK_ID `integer`	Together with `MENU_CODE`, adds a link to the created page in the menu of the block with the specified identifier
MENU_CODE `string`	Together with `BLOCK_ID`, specifies the menu code within the block where the link to the created page should be added

Parameter PREPARE_BLOCKS_DATA

Allows you to pass settings for individual template blocks even before the page is created.

Used only together with PREPARE_BLOCKS: true. If PREPARE_BLOCKS is not provided or is not passed as boolean true, the parameter is ignored.

Structure of the object:

{
            "block_code_from_template": {
                "ACTION": "changeComponentParams",
                "PARAMS": {
                    "PARAMETER_NAME": "value"
                }
            }
        }

Name
type

Description

ACTION
string

What needs to be done with the block. The value changeComponentParams is supported

PARAMS
object

Component parameters that need to be substituted into the block when creating the page.

Replacement applies only to parameters that are defined as an empty string in the block template

The set of supported parameters depends on the specific block. For example, the following parameters may be used in blocks:

Parameter	Description
`IBLOCK_ID`	Identifier of the catalog information block
`SECTION_ID`	Identifier of the catalog section
`ELEMENT_ID`	Identifier of the catalog element
`REQUISITE`	Identifier of the company requisite in the format `{COMPANY_ID}_{REQUISITE_ID}` for blocks `69.1.contacts` and `69.2.requisites`
`BANK_REQUISITE`	Identifier of the bank requisite in the format `{COMPANY_ID}_{BANK_REQUISITE_ID}` for the block `69.3.bank_requisites`

The block code must match the block code in the template.

If landing.demos.getPageList returns the composition of blocks for the selected template, the block code can be taken from DATA.items[].code.

If the composition of blocks is not returned, create a test page and check the block codes using the landing.block.getList method.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "siteId": 157,
            "code": "krayt.monotovar@KraytPetShop",
            "fields": {
              "TITLE": "Spring Promotion",
              "DESCRIPTION": "SEO description of the promotion page",
              "FOLDER_ID": 95
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.landing.addByTemplate.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "siteId": 157,
            "code": "krayt.monotovar@KraytPetShop",
            "fields": {
              "TITLE": "Spring Promotion",
              "DESCRIPTION": "SEO description of the promotion page",
              "FOLDER_ID": 95
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.landing.addByTemplate.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.landing.addByTemplate',
            params: {
              siteId: 157,
              code: 'krayt.monotovar@KraytPetShop',
              fields: {
                TITLE: 'Spring sale',
                DESCRIPTION: 'SEO page description',
                FOLDER_ID: 95,
              },
            },
            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('Created page ID:', 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 addLandingByTemplate() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'landing.landing.addByTemplate',
                params: {
                  siteId: 157,
                  code: 'krayt.monotovar@KraytPetShop',
                  fields: {
                    TITLE: 'Spring sale',
                    DESCRIPTION: 'SEO page description',
                    FOLDER_ID: 95,
                  },
                },
                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('Created page ID:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addLandingByTemplate)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.landing.landing.add_by_template(
                site_id=157,
                code="krayt.monotovar@KraytPetShop",
                fields={
                    "TITLE": "Spring sale",
                    "DESCRIPTION": "SEO page description",
                    "FOLDER_ID": 95,
                },
            ).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 {
            $response = $b24Service
                ->core
                ->call(
                    'landing.landing.addByTemplate',
                    [
                        'siteId' => 157,
                        'code' => 'krayt.monotovar@KraytPetShop',
                        'fields' => [
                            'TITLE' => 'Spring Promotion',
                            'DESCRIPTION' => 'SEO description of the promotion page',
                            'FOLDER_ID' => 95,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding landing page by template: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.landing.addByTemplate',
            {
                siteId: 157,
                code: 'krayt.monotovar@KraytPetShop',
                fields: {
                    TITLE: 'Spring Promotion',
                    DESCRIPTION: 'SEO description of the promotion page',
                    FOLDER_ID: 95
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'landing.landing.addByTemplate',
            [
                'siteId' => 157,
                'code' => 'krayt.monotovar@KraytPetShop',
                'fields' => [
                    'TITLE' => 'Spring Promotion',
                    'DESCRIPTION' => 'SEO description of the promotion page',
                    'FOLDER_ID' => 95,
                ],
            ]
        );
        
        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.landing.addByTemplate", b24.Params{
        	"siteId": 157,
        	"code":   "krayt.monotovar@KraytPetShop",
        	"fields": b24.Params{
        		"TITLE":       "Spring Promotion",
        		"DESCRIPTION": "SEO description of the promotion page",
        		"FOLDER_ID":   95,
        	},
        })
        if err != nil {
        	return fmt.Errorf("landing.landing.addByTemplate: %w", err)
        }
        
        var value b24.ID
        if err := json.Unmarshal(res.Result, &value); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("result:", value)

Response Handling

HTTP Status: 200

{
            "result": 2229,
            "time": {
                "start": 1773700566,
                "finish": 1773700567.67178,
                "duration": 1.6717801094055176,
                "processing": 1,
                "date_start": "2026-03-17T01:36:06+01:00",
                "date_finish": "2026-03-17T01:36:07+01:00",
                "operating_reset_at": 1773701166,
                "operating": 1.4516642093658447
            }
        }

Returned Data

Name `type`	Description
result `integer`	Identifier of the created page
time `time`	Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "SITE_ERROR",
            "error_description": "Site not found or access denied"
        }

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
`MISSING_PARAMS`	Required parameters are missing: `siteId`, `code`, or both parameters are absent in the request
`SITE_ERROR`	Site not found or access denied: a non-existent site is provided in `siteId` or the user does not have access to it
`LANDING_ERROR`	Page or folder not found: an identifier of an element that does not exist in the specified site is provided in `fields.ID`
`ACCESS_DENIED`	Access to create the page is denied: the user does not have "edit" permission for the specified site
`FOLDER_NOT_FOUND`	Folder not found: a folder that does not belong to the specified site or does not exist is provided in `fields.FOLDER_ID`
`WRONG_DATA`	Invalid template data: unable to retrieve template data for the provided `code`
`SLASH_IS_NOT_ALLOWED`	Slash is not allowed in the landing address: the template contains an invalid address for the created page
`CANT_BE_EMPTY`	The page address cannot be empty: the template contains an empty address for the created page
`WRONG_CODE_FORMAT`	Invalid page address: the template contains an address in the format `<characters>_<number>_<number>`, for example `code_12_34`

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?

Add Page or Folder

Copying a Page

Add Page by Template landing.landing.addByTemplate

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Parameter PREPARE_BLOCKS_DATAParameter PREPARE_BLOCKS_DATA

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