Set Included Areas for the Site landing.template.setSiteRef

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.template.setSiteRef saves the bindings of included areas for the site. It only works with site bindings and does not change the bindings of individual pages.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Site identifier.

The site identifier can be obtained using the landing.site.getList method.

data
object | array

A set of bindings for the included areas of the site (detailed description).

If the parameter is not provided or an empty object {} or array [] is passed, the method will remove all current bindings of included areas for this site.

Parameter data

Name
type

Description

<AREA_ID>
integer

Identifier of the page to be assigned to the corresponding included area.

The key is the identifier of the template area, and the value is the page identifier.

Area identifiers depend on the site template. They can be determined by the template, for example, through the landing.template.getlist method and the CONTENT field: in the markup, areas are denoted as #AREA_1#, #AREA_2#, and so on.

In data, only the numeric part of such an identifier should be passed: 1, 2. If a key is not provided for a saved area in data or if a value of 0, an empty string, null, or a negative number is passed, the binding will be removed.

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": 157,
            "data": {
              "1": 614,
              "2": 615,
              "3": 616
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.template.setSiteRef.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 157,
            "data": {
              "1": 614,
              "2": 615,
              "3": 616
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.template.setSiteRef.json"

try
        {
            const response = await $b24.callMethod(
                'landing.template.setSiteRef',
                {
                    id: 157,
                    data: {
                        1: 614,
                        2: 615,
                        3: 616
                    }
                }
            );
        
            const result = response.getData().result;
            console.info(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.template.setSiteRef',
                    [
                        'id' => 157,
                        'data' => [
                            1 => 614,
                            2 => 615,
                            3 => 616,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting site refs: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.template.setSiteRef',
            {
                id: 157,
                data: {
                    1: 614,
                    2: 615,
                    3: 616
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'landing.template.setSiteRef',
            [
                'id' => 157,
                'data' => [
                    1 => 614,
                    2 => 615,
                    3 => 616,
                ],
            ]
        );
        
        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": 1774893504,
                "finish": 1774893504.131602,
                "duration": 0.13160204887390137,
                "processing": 0,
                "date_start": "2026-03-30T20:58:24+02:00",
                "date_finish": "2026-03-30T20:58:24+02:00",
                "operating_reset_at": 1774894104,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
boolean

The result of the call.

The method returns true if the request completed without error.

The method may return true if nothing has changed. For example, when the same bindings are already saved for the site, the user does not have permission to modify settings, or only values that are not saved are passed.

time
time

Information about the request execution time.

Error Handling

HTTP Status: 400

{
            "error": "ENTITY_NOT_FOUND",
            "error_description": "Entity not found"
        }

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`	The required parameter `id` is missing.
`ENTITY_NOT_FOUND`	The site is not found or is unavailable.
`ACCESS_DENIED`	The user does not have permission to modify site settings.

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

Set Included Areas for the Page

Overview of Methods

Set Included Areas for the Site landing.template.setSiteRef

Method ParametersMethod Parameters

Parameter dataParameter 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

Method Parameters

Parameter data

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning