Set Included Areas for the Site landing.template.setSiteRef
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 "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 |
Description |
|
id* |
Site identifier. The site identifier can be obtained using the landing.site.getList method. |
|
A set of bindings for the included areas of the site (detailed description). If the parameter is not provided or an empty object |
Parameter data
|
Name |
Description |
|
<AREA_ID> |
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 In |
Code Examples
How to Use Examples in Documentation
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"
// 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<boolean>({
method: 'landing.template.setSiteRef',
params: {
id: 157,
data: {
1: 614,
2: 615,
3: 616,
},
},
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('Site refs saved:', 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 setSiteRef() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'landing.template.setSiteRef',
params: {
id: 157,
data: {
1: 614,
2: 615,
3: 616,
},
},
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('Site refs saved:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', setSiteRef)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.landing.template.set_site_ref(
bitrix_id=157,
data={
1: 614,
2: 615,
3: 616,
},
).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.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>';
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "landing.template.setSiteRef", b24.Params{
"id": 157,
"data": b24.Params{
"1": 614,
"2": 615,
"3": 616,
},
})
if err != nil {
return fmt.Errorf("landing.template.setSiteRef: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("done:", ok)
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 |
Description |
|
result |
The result of the call. The method returns The method may return |
|
time |
Information about the request execution time. |
Error Handling
HTTP Status: 400
{
"error": "ENTITY_NOT_FOUND",
"error_description": "Entity not found"
}
|
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 |
|
|
The required parameter |
|
|
The site is not found or is unavailable. |
|
|
The user does not have permission to modify site settings. |
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 |