Добавить страницу по шаблону landing.landing.addByTemplate

Scope: landing

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

Метод landing.landing.addByTemplate создает страницу в указанном сайте по коду шаблона и возвращает идентификатор созданной страницы. Новая страница создается неактивной (ACTIVE = N).

Если нужно полностью управлять полями создаваемой страницы, используйте landing.landing.add.

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

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

Название
тип

Описание

siteId*
integer

Идентификатор сайта, в котором нужно создать страницу.

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

code*
string

Код шаблона страницы.

Список доступных шаблонов можно получить методом landing.demos.getPageList. Код зависит от шаблонов, доступных в Битрикс24. Например, значение может выглядеть как krayt.monotovar@KraytPetShop

fields
object

Дополнительные параметры создания страницы (подробное описание)

Параметр fields

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

Название
тип

Описание

TITLE
string

Переопределяет заголовок создаваемой страницы и SEO-заголовки шаблона.

Если не передавать, будут использованы значения из шаблона

DESCRIPTION
string

Переопределяет SEO-описания шаблона.

Значение записывается в дополнительные поля METAOG_DESCRIPTION и METAMAIN_DESCRIPTION, но не в поле DESCRIPTION самой страницы

ID
integer

Идентификатор существующей страницы или папки в том же сайте.

Если передать папку, новая страница создастся в ней. Если передать страницу из папки, новая страница создастся в той же папке. Для элемента без папки метод возьмет значение из fields.FOLDER_ID, если этот параметр указан.

Если передан активный элемент, новая страница после создания опубликуется автоматически. Если ID указывает на папку или на элемент с заполненным FOLDER_ID, параметр fields.FOLDER_ID не учитывается.

Идентификатор страницы можно получить методом landing.landing.getList, идентификатор папки — методом landing.site.getFolders

FOLDER_ID
integer

Идентификатор папки, в которой нужно создать страницу. Папка должна относиться к тому же сайту, что и siteId, иначе метод вернет ошибку.

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

Параметр используется, если папка создания не определилась по fields.ID

SITE_TYPE
string

Тип шаблонов, из которого создается страница. Используются типы сайтов из статьи Работа с типами сайтов и скоупами.

Если не передавать, берется тип сайта. Для сайтов типов STORE и SMN по умолчанию используется значение PAGE

PREPARE_BLOCKS
boolean

Включает подготовку блоков шаблона при создании страницы.

Работает только вместе с PREPARE_BLOCKS_DATA. Передавайте именно boolean true

PREPARE_BLOCKS_DATA
object

Дополнительные данные для подготовки блоков шаблона при создании страницы.

В PREPARE_BLOCKS_DATA сначала укажите код блока из шаблона страницы, а внутри - параметры для этого блока (подробное описание)

ADD_IN_MENU
string

Флаг добавления созданной страницы в меню сайта. Поддерживаются Y и N.

Логика срабатывает только при значении Y, если страница еще не добавляется в меню через BLOCK_ID и MENU_CODE, и если передан TITLE

BLOCK_ID
integer

Вместе с MENU_CODE добавляет ссылку на созданную страницу в меню блока с указанным идентификатором

MENU_CODE
string

Вместе с BLOCK_ID указывает код меню внутри блока, куда нужно добавить ссылку на созданную страницу

Параметр PREPARE_BLOCKS_DATA

Позволяет передать настройки для отдельных блоков шаблона еще до создания страницы.

Используется только вместе с PREPARE_BLOCKS: true. Если PREPARE_BLOCKS не передан или передан не как boolean true, параметр игнорируется.

Структура объекта:

{
            "код_блока_из_шаблона": {
                "ACTION": "changeComponentParams",
                "PARAMS": {
                    "НАЗВАНИЕ_ПАРАМЕТРА": "значение"
                }
            }
        }

Название
тип

Описание

ACTION
string

Что нужно сделать с блоком. Поддерживается значение changeComponentParams

PARAMS
object

Параметры компонента, которые нужно подставить в блок при создании страницы.

Замена применяется только к параметрам, которые в шаблоне блока заданы пустой строкой

Набор поддерживаемых параметров зависит от конкретного блока. Например, в блоках могут использоваться такие параметры:

Параметр

Описание

IBLOCK_ID

Идентификатор инфоблока каталога

SECTION_ID

Идентификатор раздела каталога

ELEMENT_ID

Идентификатор элемента каталога

REQUISITE

Идентификатор реквизита компании в формате {ID_компании}_{ID_реквизита} для блоков 69.1.contacts и 69.2.requisites

BANK_REQUISITE

Идентификатор банковского реквизита в формате {ID_компании}_{ID_банковского_реквизита} для блока 69.3.bank_requisites

Код блока должен совпадать с кодом блока в шаблоне.

Если landing.demos.getPageList возвращает состав блоков для выбранного шаблона, код блока можно взять из DATA.items[].code.

Если состав блоков не возвращается, создайте тестовую страницу и посмотрите коды блоков методом landing.block.getList.

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "siteId": 157,
            "code": "krayt.monotovar@KraytPetShop",
            "fields": {
              "TITLE": "Весенняя акция",
              "DESCRIPTION": "SEO-описание страницы акции",
              "FOLDER_ID": 95
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.landing.addByTemplate.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "siteId": 157,
            "code": "krayt.monotovar@KraytPetShop",
            "fields": {
              "TITLE": "Весенняя акция",
              "DESCRIPTION": "SEO-описание страницы акции",
              "FOLDER_ID": 95
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.landing.addByTemplate.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'landing.landing.addByTemplate',
        		{
        			siteId: 157,
        			code: 'krayt.monotovar@KraytPetShop',
        			fields: {
        				TITLE: 'Весенняя акция',
        				DESCRIPTION: 'SEO-описание страницы акции',
        				FOLDER_ID: 95
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.landing.addByTemplate',
                    [
                        'siteId' => 157,
                        'code' => 'krayt.monotovar@KraytPetShop',
                        'fields' => [
                            'TITLE' => 'Весенняя акция',
                            'DESCRIPTION' => 'SEO-описание страницы акции',
                            'FOLDER_ID' => 95,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding landing page by template: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.landing.addByTemplate',
            {
                siteId: 157,
                code: 'krayt.monotovar@KraytPetShop',
                fields: {
                    TITLE: 'Весенняя акция',
                    DESCRIPTION: 'SEO-описание страницы акции',
                    FOLDER_ID: 95
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.landing.addByTemplate',
            [
                'siteId' => 157,
                'code' => 'krayt.monotovar@KraytPetShop',
                'fields' => [
                    'TITLE' => 'Весенняя акция',
                    'DESCRIPTION' => 'SEO-описание страницы акции',
                    'FOLDER_ID' => 95,
                ],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Ошибка: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

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

HTTP-статус: 200

{
            "result": 2229,
            "time": {
                "start": 1773700566,
                "finish": 1773700567.67178,
                "duration": 1.6717801094055176,
                "processing": 1,
                "date_start": "2026-03-17T01:36:06+03:00",
                "date_finish": "2026-03-17T01:36:07+03:00",
                "operating_reset_at": 1773701166,
                "operating": 1.4516642093658447
            }
        }

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

Название
тип

Описание

result
integer

Идентификатор созданной страницы

time
time

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

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

HTTP-статус: 400

{
            "error": "SITE_ERROR",
            "error_description": "Сайт не найден, или доступ к нему запрещен"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

MISSING_PARAMS

Не переданы обязательные параметры вызова: в запросе отсутствует siteId, code или оба параметра

SITE_ERROR

Сайт не найден, или доступ к нему запрещен: в siteId передан несуществующий сайт или у пользователя нет доступа к нему

LANDING_ERROR

Страница или папка не найдена: в fields.ID передан идентификатор элемента, которого нет в указанном сайте

ACCESS_DENIED

Доступ на создание страницы запрещен: у пользователя нет права «редактирование» для указанного сайта

FOLDER_NOT_FOUND

Папка не найдена: в fields.FOLDER_ID передана папка, которая не относится к указанному сайту или не существует

WRONG_DATA

Некорректные данные шаблона: для переданного code не удалось получить данные шаблона страницы

SLASH_IS_NOT_ALLOWED

Слеш запрещен в адресе лендинга: шаблон содержит недопустимый адрес создаваемой страницы

CANT_BE_EMPTY

Адрес страницы не может быть пустым: шаблон содержит пустой адрес создаваемой страницы

WRONG_CODE_FORMAT

Недопустимый адрес страницы: шаблон содержит адрес в формате <символы>_<число>_<число>, например code_12_34

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

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

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

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

Предыдущая
Добавить страницу или папку
Следующая
Копировать страницу