Добавить блок на страницу landing.landing.addblock

Scope: landing

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

Метод landing.landing.addblock добавляет новый блок на страницу и возвращает идентификатор созданного блока.

Если страница уже опубликована, для посетителей новый блок станет виден после команды «Опубликовать изменения» в интерфейсе или после вызова метода landing.landing.publication.

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

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

Название
тип

Описание

scope
string

Внутренний скоуп лендингов. Он не связан с REST-скоупом landing в названии метода.

Для страниц типов PAGE, STORE и SMN параметр передавать не нужно. Для страниц в скоупах GROUP, KNOWLEDGE и MAINPAGE передайте такое же значение scope. Правила выбора значения описаны в статье Работа с типами сайтов и скоупами

lid*
integer

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

Идентификатор страницы можно получить методом landing.landing.getList, а также из результата методов landing.landing.add, landing.landing.addByTemplate и landing.landing.copy

fields*
object

Набор параметров нового блока (подробное описание)

preventHistory
boolean

Если true, метод не добавляет действие в историю изменений страницы. По умолчанию false

Параметр fields

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

Название
тип

Описание

CODE*
string

Символьный код блока из репозитория.

Код можно получить методом landing.block.getrepository: для fields.CODE нужно брать ключ элемента из result.items, например 02.three_cols_big_1 или repo_385.

Для блока, зарегистрированного приложением через landing.repo.register, используйте значение вида repo_<ID>.

Доступность кода зависит от типа страницы и от верхнеуровневого параметра scope, если он передан. Если получаете код через landing.block.getrepository, используйте тот же scope, что и в landing.landing.addblock.

Если параметр не передан или передан пустой строкой, метод вернет ошибку

AFTER_ID
integer

Идентификатор блока, после которого нужно вставить новый блок.

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

Если передать идентификатор существующего блока на странице, новый блок будет добавлен сразу после него. Если параметр не передан, новый блок добавится в начало страницы.

Если AFTER_ID передан, но блока с таким идентификатором на странице нет, отдельной ошибки не будет. В этом случае новый блок тоже добавится в начало страницы

ACTIVE
string

Флаг активности нового блока. Возможные значения:

Y — блок активен
N — блок неактивен

По умолчанию — Y

CONTENT
string

HTML-содержимое блока. Позволяет заменить стандартный контент блока своим HTML-кодом. При этом код блока все равно должен быть доступен в репозитории для текущего типа страницы и scope. Перед сохранением значение очищается и проверяется

RETURN_CONTENT
string

Если передать Y, после добавления блока метод вернет не только его идентификатор, но и данные блока (подробное описание). При любом другом значении метод вернет только идентификатор блока

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "lid": 351,
            "fields": {
              "CODE": "02.three_cols_big_1",
              "AFTER_ID": 6428,
              "ACTIVE": "Y"
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.landing.addblock.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "lid": 351,
            "fields": {
              "CODE": "02.three_cols_big_1",
              "AFTER_ID": 6428,
              "ACTIVE": "Y"
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.landing.addblock.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'landing.landing.addblock',
        		{
        			lid: 351,
        			fields: {
        				CODE: '02.three_cols_big_1',
        				AFTER_ID: 6428,
        				ACTIVE: 'Y'
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.landing.addblock',
                    [
                        'lid' => 351,
                        'fields' => [
                            'CODE' => '02.three_cols_big_1',
                            'AFTER_ID' => 6428,
                            'ACTIVE' => 'Y',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding block: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.landing.addblock',
            {
                lid: 351,
                fields: {
                    CODE: '02.three_cols_big_1',
                    AFTER_ID: 6428,
                    ACTIVE: 'Y'
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.landing.addblock',
            [
                'lid' => 351,
                'fields' => [
                    'CODE' => '02.three_cols_big_1',
                    'AFTER_ID' => 6428,
                    'ACTIVE' => 'Y',
                ],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Ошибка: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }
        

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

HTTP-статус: 200

{
            "result": 28597,
            "time": {
                "start": 1773923439,
                "finish": 1773923439.57418,
                "duration": 0.5741798877716064,
                "processing": 0,
                "date_start": "2026-03-19T15:30:39+03:00",
                "date_finish": "2026-03-19T15:30:39+03:00",
                "operating_reset_at": 1773924039,
                "operating": 0.10522103309631348
            }
        }
        

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

Название
тип

Описание

result
integer | object

Идентификатор созданного блока. Если передан fields.RETURN_CONTENT = 'Y', метод вернет объект блока (подробное описание)

time
time

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

Объект result при RETURN_CONTENT = 'Y'

Название
тип

Описание

id
integer

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

sections
string

Коды разделов блока из манифеста, объединенные в одну строку через запятую

active
boolean

Признак активности блока

access
string

Уровень доступа к блоку

anchor
string

Локальный якорь блока. По умолчанию новый блок получает якорь вида b<ID>, например b28597

php
boolean

Признак того, что в контенте блока есть PHP-код

designed
boolean

Признак дизайнерского блока

repoId
integer

Идентификатор rest-блока из репозитория или null, если блок не связан с rest-репозиторием

content
string

Подготовленный HTML-код блока

content_ext
string

Дополнительный HTML-код подключаемых расширений

css
array

Список CSS-ресурсов блока

js
array

Список JS-ресурсов блока. Для стандартных блоков из репозитория поле может содержать подключения. Для REST-блоков вида repo_<ID> при RETURN_CONTENT = 'Y' поле возвращается пустым массивом

assetStrings
array

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

lang
array | object

Языковые сообщения подключенных расширений. Если сообщения есть, поле возвращается как объект вида ключ-значение. Если дополнительных сообщений нет, может вернуться пустой массив

manifest
object

Манифест блока. Формат описан в разделе Манифест блока

dynamicParams
array

Параметры динамического блока

requiredUserAction
array

Поле содержит те же данные, что и manifest.requiredUserAction. Оно возвращается только тогда, когда после добавления блока пользователь должен выполнить дополнительное действие на стороне клиента. Какие именно данные будут в поле, зависит от манифеста блока

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

HTTP-статус: 400

{
            "error": "BLOCK_CANT_BE_ADDED",
            "error_description": "Cannot add block because it is not intended for this type of page."
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

MISSING_PARAMS

Не передан обязательный верхнеуровневый параметр lid или fields

LANDING_NOT_EXIST

Страница с идентификатором lid не найдена

ACCESS_DENIED

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

BLOCK_CANT_BE_ADDED

Код из fields.CODE отсутствует в доступном репозитории, этот блок нельзя добавить на страницу текущего типа или переданный scope ограничил набор доступных блоков. Та же ошибка возвращается, если fields.CODE не передан или передан пустой строкой

BLOCK_WRONG_VERSION

Версия блока из репозитория выше версии установленного модуля landing

BLOCK_NOT_FOUND

Для блока не найден контент, в том числе если передан пустой fields.CONTENT

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

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

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

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