Add Page or Folder landing.landing.add

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the MCP server so that the assistant can utilize the official REST documentation.

Scope: landing

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

The method landing.landing.add adds a page or folder to the specified site and returns the identifier of the created object. The new object is created as inactive (ACTIVE = N).

Method Parameters

Required parameters are marked with *

Name
type

Description

scope
string

Internal scope of the landing. 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)

fields*
object

Set of fields for the new page or folder (detailed description)

Parameter fields

Required parameters are marked with *

Name
type

Description

TITLE*
string

Title of the page

SITE_ID*
integer

Identifier of the site where the page is created.

The site identifier can be obtained using the method landing.site.getList or from the result of the method landing.site.add

CODE
string

Symbolic code of the page. It must not contain the character / and must not be in the format <characters>_<number>_<number>, for example code_12_34.

If the field is not provided or a string consisting only of spaces is passed, the code will be generated from TITLE. If the transliterated code turns out to be empty, a string of 12 characters will be generated.

An empty string '' without the FOLDER parameter cannot be passed — the method will return an error. If the FOLDER parameter is passed with any value, an empty string is allowed, and the code will be generated from TITLE.

If such a code is already used within the site or folder after creation, a suffix of the form _<4 random characters> will be added to it

DESCRIPTION
string

Arbitrary description of the page

XML_ID
string

External identifier of the page

SITEMAP
string

Flag to include the page in the sitemap. Supported values are Y and N, default is N

FOLDER
string

Used if a folder needs to be created instead of a page. Supported values are Y and N, default is N

FOLDER_ID
integer

Identifier of the folder where the page should be created. The folder must belong to the same site as SITE_ID.

The folder identifier can be obtained using the method landing.site.getFolders

TPL_ID
integer

Identifier of the page view template.

The identifier of the view template can be obtained using the method landing.template.getlist

ADDITIONAL_FIELDS
object

Additional fields of the page. Available codes and values are described in the article Additional Page Fields

BLOCK_ID
integer

Used together with MENU_CODE to add a link to the menu of the block with the specified identifier after the page is created

MENU_CODE
string

Used together with BLOCK_ID to specify the menu code in the block where the link to the created page should be added

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "fields": {
              "TITLE": "Spring Promotion",
              "SITE_ID": 292,
              "CODE": "spring-sale",
              "DESCRIPTION": "Page for seasonal promotion",
              "ADDITIONAL_FIELDS": {
                "THEME_CODE": "wedding"
              }
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.landing.add.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "fields": {
              "TITLE": "Spring Promotion",
              "SITE_ID": 292,
              "CODE": "spring-sale",
              "DESCRIPTION": "Page for seasonal promotion",
              "ADDITIONAL_FIELDS": {
                "THEME_CODE": "wedding"
              }
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.landing.add.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'landing.landing.add',
        		{
        			fields: {
        				TITLE: 'Spring Promotion',
        				SITE_ID: 292,
        				CODE: 'spring-sale',
        				DESCRIPTION: 'Page for seasonal promotion',
        				ADDITIONAL_FIELDS: {
        					THEME_CODE: 'wedding'
        				}
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.landing.add',
                    [
                        'fields' => [
                            'TITLE' => 'Spring Promotion',
                            'SITE_ID' => 292,
                            'CODE' => 'spring-sale',
                            'DESCRIPTION' => 'Page for seasonal promotion',
                            'ADDITIONAL_FIELDS' => [
                                'THEME_CODE' => 'wedding',
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding landing page: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.landing.add',
            {
                fields: {
                    TITLE: 'Spring Promotion',
                    SITE_ID: 292,
                    CODE: 'spring-sale',
                    DESCRIPTION: 'Page for seasonal promotion',
                    ADDITIONAL_FIELDS: {
                        THEME_CODE: 'wedding'
                    }
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.landing.add',
            [
                'fields' => [
                    'TITLE' => 'Spring Promotion',
                    'SITE_ID' => 292,
                    'CODE' => 'spring-sale',
                    'DESCRIPTION' => 'Page for seasonal promotion',
                    'ADDITIONAL_FIELDS' => [
                        'THEME_CODE' => 'wedding',
                    ],
                ],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Error: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }
        

Warning

If you want the new page to immediately appear in the block menu, pass both service parameters: BLOCK_ID and MENU_CODE in fields

Response Handling

HTTP Status: 200

{
            "result": 2227,
            "time": {
                "start": 1773694924,
                "finish": 1773694924.307754,
                "duration": 0.3077540397644043,
                "processing": 0,
                "date_start": "2026-03-17T00:02:04+01:00",
                "date_finish": "2026-03-17T00:02:04+01:00",
                "operating_reset_at": 1773695524,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
integer

Identifier of the created page or folder

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "SLASH_IS_NOT_ALLOWED",
            "error_description": "Slash is not allowed in the landing address."
        }
        

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 top-level parameter fields is missing

ACCESS_DENIED

Access to create the page is denied: the user does not have "edit" permission for the specified site

SITE_NOT_FOUND

Site not found: a non-existent site identifier is passed in fields.SITE_ID

FOLDER_NOT_FOUND

Folder not found: a folder that does not belong to the specified site or does not exist is passed in fields.FOLDER_ID

SLASH_IS_NOT_ALLOWED

Slash is not allowed in the landing address: a character / is passed in fields.CODE

CANT_BE_EMPTY

The page address cannot be empty: an empty string '' is passed in fields.CODE

WRONG_CODE_FORMAT

Invalid page address: a value in the format <characters>_<number>_<number> is passed in fields.CODE, 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 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