Установить включаемые области для сайта landing.template.setSiteRef

Scope: landing

Кто может выполнять метод: пользователь с правом «изменение настроек» для сайта

Метод landing.template.setSiteRef сохраняет привязки включаемых областей для сайта. Он работает только с привязками сайта и не меняет привязки отдельных страниц.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

Идентификатор сайта.

Идентификатор сайта можно получить методом landing.site.getList

data
object | array

Набор привязок включаемых областей сайта (подробное описание).

Если не передать параметр или передать пустой объект {} или массив [], метод удалит все текущие привязки включаемых областей для этого сайта

Параметр data

Название
тип

Описание

<ID_ОБЛАСТИ>
integer

Идентификатор страницы, которую нужно назначить в соответствующую включаемую область.

Ключом служит идентификатор области шаблона, значением — идентификатор страницы.

Идентификаторы областей зависят от шаблона сайта. Их можно определить по шаблону, например через метод landing.template.getlist и поле CONTENT: в разметке области обозначаются как #AREA_1#, #AREA_2# и так далее

В data нужно передавать только числовую часть такого идентификатора: 1, 2. Если для сохраненной области не передать ключ в data или передать для нее значение 0, пустую строку, null либо отрицательное число, привязка будет удалена

Примеры кода

Как использовать примеры в документации

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 'Ошибка: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

Обработка ответа

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1774893504,
                "finish": 1774893504.131602,
                "duration": 0.13160204887390137,
                "processing": 0,
                "date_start": "2026-03-30T20:58:24+03:00",
                "date_finish": "2026-03-30T20:58:24+03:00",
                "operating_reset_at": 1774894104,
                "operating": 0
            }
        }

Возвращаемые данные

Название
тип

Описание

result
boolean

Результат вызова.

Метод возвращает true, если запрос завершился без ошибки.

Метод может вернуть true, если ничего не изменилось. Например, когда для сайта уже сохранены такие же привязки, у пользователя нет права на изменение настроек или переданы только значения, которые не сохраняются

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error": "ENTITY_NOT_FOUND",
            "error_description": "Сущность не найдена"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

MISSING_PARAMS

Не передан обязательный параметр id

ENTITY_NOT_FOUND

Сайт не найден или недоступен

ACCESS_DENIED

У пользователя нет прав на изменение настроек сайта

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Установить включаемые области для страницы
Следующая
О местах встраивания