Add Page by Template landing.landing.addByTemplate

Scope: landing

Who can execute the method: user with "edit" access permission for the site

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

If you need full control over the fields of the created page, use landing.landing.add.

Method Parameters

Required parameters are marked with *

Name `type`	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`	Code of the page template. 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 may 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 `PAGE` is used
PREPARE_BLOCKS `boolean`	Enables the preparation of template blocks when creating the page. Works only 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. Supports `Y` and `N`. The logic triggers only with the value `Y`, if the page is not already added to the menu via `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 creating the page.

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

Object structure:

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

Name
type

Description

ACTION
string

What to do 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 empty strings 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 item
`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 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)

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"

try
        {
        	const response = await $b24.callMethod(
        		'landing.landing.addByTemplate',
        		{
        			siteId: 157,
        			code: 'krayt.monotovar@KraytPetShop',
        			fields: {
        				TITLE: 'Spring Promotion',
        				DESCRIPTION: 'SEO description of the promotion page',
        				FOLDER_ID: 95
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.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>';
        }

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 to it is denied"
        }

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
`MISSING_PARAMS`	Required parameters are not provided: `siteId`, `code`, or both parameters are missing in the request
`SITE_ERROR`	Site not found, or access to it is 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`	Incorrect template data: failed 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: 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 allowed to be called 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 methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users
`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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

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