Set a Special Page for the Site landing.syspage.set

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

Scope: landing

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

The method landing.syspage.set assigns a special page for the site.

Method Parameters

Required parameters are marked with *

Name `type`	Description
id* `integer`	Site identifier. The site identifier can be obtained using the method landing.site.getList or from the result of the method landing.site.add
type* `string`	Code for the special page. Possible values: `mainpage` — main page `catalog` — catalog main page `personal` — personal section `cart` — shopping cart `order` — order checkout `payment` — payment page `compare` — comparison page `feedback` — feedback page Leading and trailing spaces are trimmed. If a code outside the list is provided after this, the method will terminate without changes
lid `integer`	Identifier of the page to be set as special for the site. This parameter is filled if the page needs to be designated as special. If the parameter is not provided, the method will remove the current binding for `type`. The method will terminate without changes and without error in two cases: if there is no binding for the pair `id` and `type`, or if a page that does not exist or is not available for modification is provided. Values `0`, `null`, and an empty string are not considered as the absence of a parameter. They are retained as `0`. For such values, access permissions for the page are not additionally checked

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 '{
            "id": 1390,
            "type": "personal",
            "lid": 8593
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.syspage.set.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 1390,
            "type": "personal",
            "lid": 8593,
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.syspage.set.json"

try
        {
        	const response = await $b24.callMethod(
        		'landing.syspage.set',
        		{
        			id: 1390,
        			type: 'personal',
        			lid: 8593
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.syspage.set',
                    [
                        'id' => 1390,
                        'type' => 'personal',
                        'lid' => 8593,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting special page: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.syspage.set',
            {
                id: 1390,
                type: 'personal',
                lid: 8593
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'landing.syspage.set',
            [
                'id' => 1390,
                'type' => 'personal',
                'lid' => 8593,
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Error: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1774296164,
                "finish": 1774296164.30144,
                "duration": 0.3014400005340576,
                "processing": 0,
                "date_start": "2026-03-23T23:02:44+01:00",
                "date_finish": "2026-03-23T23:02:44+01:00",
                "operating_reset_at": 1774296764,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
boolean

Result of the call.

The method returns true if the call completed without error. This does not always mean that the binding was created, updated, or deleted. In some cases, the method may return true if nothing changed.

For example, if type is not supported, the site or page is unavailable, the page from lid is not found, or there is no binding to delete yet

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "MISSING_PARAMS",
            "error_description": "Insufficient call parameters, missing: id"
        }

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 parameter `id` or `type` not provided
`ACCESS_DENIED`	Insufficient general permissions to call `landing` methods
`SYSTEM_ERROR`	Unexpected internal error during method execution

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

Overview of Methods

Get List of Pages

Set a Special Page for the Site landing.syspage.set

Method ParametersMethod Parameters

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