Изменить якорь блока landing.block.changeAnchor

Scope: landing

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

Метод landing.block.changeAnchor изменяет или удаляет пользовательский якорь блока в черновике страницы.

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

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

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

Название
тип

Описание

lid*
integer

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

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

block*
integer

Идентификатор блока в черновике страницы.

Идентификатор блока можно получить методом landing.block.getlist с параметром params.edit_mode = true

data*
string

Новый якорь блока без символа #.

Передавайте значение строкой. Якорь должен начинаться с буквы A-Z или a-z, содержать не менее двух символов и далее может включать только буквы A-Z и a-z, цифры 0-9 и символы -, _, ., :.

Якорь из одного символа недопустим. Например, a вызовет ошибку. Примеры допустимых значений: about-us, Section_A, faq.v2, Tab:1

preventHistory
boolean

Не добавлять изменение в историю страницы.

Возможные значения:
true — не сохранять изменение в истории,
false — сохранить изменение в истории.

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

Примеры кода

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

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

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1774525298,
                "finish": 1774525298.491831,
                "duration": 0.49183106422424316,
                "processing": 0,
                "date_start": "2026-03-26T14:41:38+03:00",
                "date_finish": "2026-03-26T14:41:38+03:00",
                "operating_reset_at": 1774525898,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
boolean

Результат изменения якоря. При успешном выполнении метод возвращает true

time
time

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

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

HTTP-статус: 400

{
            "error": "BAD_ANCHOR",
            "error_description": "Якорь должен начинаться с символа от a-z и далее может содержать только символы от \"a-z\", \"0-9\", \"-\", \"_\", \".\", \":\""
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

MISSING_PARAMS

Не передан обязательный параметр lid, block или data

LANDING_NOT_EXIST

Страница с идентификатором lid не найдена или недоступна текущему пользователю

BLOCK_NOT_FOUND

Блок с идентификатором block не найден в черновике страницы

ACCESS_DENIED

Недостаточно прав для редактирования сайта

BAD_ANCHOR

Передан недопустимый якорь: он начинается не с буквы, содержит запрещенные символы или состоит из одного символа

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

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

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

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

Предыдущая
Добавить карточку с измененным контентом
Следующая
Изменить название тега