Add Page or Folder landing.landing.add
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:
landingWho 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 |
Description |
|
scope |
Internal scope of the landing. It is not related to the REST scope The value of |
|
fields* |
Set of fields for the new page or folder (detailed description) |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
TITLE* |
Title of the page |
|
SITE_ID* |
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 |
Symbolic code of the page. It must not contain the character If the field is not provided or a string consisting only of spaces is passed, the code will be generated from An empty string If such a code is already used within the site or folder after creation, a suffix of the form |
|
DESCRIPTION |
Arbitrary description of the page |
|
XML_ID |
External identifier of the page |
|
SITEMAP |
Flag to include the page in the sitemap. Supported values are |
|
FOLDER |
Used if a folder needs to be created instead of a page. Supported values are |
|
FOLDER_ID |
Identifier of the folder where the page should be created. The folder must belong to the same site as The folder identifier can be obtained using the method landing.site.getFolders |
|
TPL_ID |
Identifier of the page view template. The identifier of the view template can be obtained using the method landing.template.getlist |
|
ADDITIONAL_FIELDS |
Additional fields of the page. Available codes and values are described in the article Additional Page Fields |
|
BLOCK_ID |
Used together with |
|
MENU_CODE |
Used together with |
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"
// 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.add',
params: {
fields: {
TITLE: 'Spring Sale',
SITE_ID: 292,
CODE: 'spring-sale',
DESCRIPTION: 'Page for seasonal promotion',
ADDITIONAL_FIELDS: {
THEME_CODE: 'wedding',
},
},
},
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 landing 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 addLandingPage() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'landing.landing.add',
params: {
fields: {
TITLE: 'Spring Sale',
SITE_ID: 292,
CODE: 'spring-sale',
DESCRIPTION: 'Page for seasonal promotion',
ADDITIONAL_FIELDS: {
THEME_CODE: 'wedding',
},
},
},
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 landing page ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addLandingPage)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.landing.landing.add(
fields={
"TITLE": "Spring Sale",
"SITE_ID": 292,
"CODE": "spring-sale",
"DESCRIPTION": "Page for seasonal promotion",
"ADDITIONAL_FIELDS": {
"THEME_CODE": "wedding",
},
},
).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.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>';
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "landing.landing.add", b24.Params{
"fields": b24.Params{
"TITLE": "Spring Promotion",
"SITE_ID": 292,
"CODE": "spring-sale",
"DESCRIPTION": "Page for seasonal promotion",
"ADDITIONAL_FIELDS": b24.Params{
"THEME_CODE": "wedding",
},
},
})
if err != nil {
return fmt.Errorf("landing.landing.add: %w", err)
}
var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("id:", newID)
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 |
Description |
|
result |
Identifier of the created page or folder |
|
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 |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
Required top-level parameter |
|
|
Access to create the page is denied: the user does not have "edit" permission for the specified site |
|
|
Site not found: a non-existent site identifier is passed in |
|
|
Folder not found: a folder that does not belong to the specified site or does not exist is passed in |
|
|
Slash is not allowed in the landing address: a character |
|
|
The page address cannot be empty: an empty string |
|
|
Invalid page address: a value in the format |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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
- Add Page by Template landing.landing.addByTemplate
- Copy Page landing.landing.copy
- Delete Page landing.landing.delete
- Get Additional Fields of the Page landing.landing.getadditionalfields
- Get a List of Pages landing.landing.getList
- Publish the landing.landing.publication page
- Update Page landing.landing.update