Изменить сайт landing.site.update

Scope: landing

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

Метод landing.site.update обновляет параметры сайта.

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

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

Название
тип

Описание

id*
integer

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

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

fields*
object

Набор полей для обновления сайта (подробное описание)

Параметр fields

Название
тип

Описание

TITLE
string

Название сайта, длина до 255 символов

CODE
string

Символьный код сайта. При передаче пустой строки код генерируется из TITLE или из строки site.

Код не может содержать /, код из одних цифр получает префикс site, максимальная длина кода 253 символа.

Если код уже занят в домене, к нему автоматически добавляется числовой суффикс

TYPE
string

Тип сайта. Поддерживаются PAGE, STORE, SMN, KNOWLEDGE, GROUP, MAINPAGE.

Это внутренний тип лендинга, он связан с внутренним scope. В landing.site.update параметр scope не передается (подробное описание)

DOMAIN_ID
integer | string

Домен сайта. Обычно передают доменное имя. Для сайтов типов PAGE, STORE, SMN, если параметр не передан или передана пустая строка, значение параметра игнорируется. Для GROUP, KNOWLEDGE и MAINPAGE параметр обычно не передают.

Для 1С-Битрикс: Управление сайтом передайте идентификатор существующего домена. Доменное имя в виде строки не поддерживается, метод вернет ошибку

DESCRIPTION
string

Описание сайта, длина до 255 символов

XML_ID
string

Внешний идентификатор сайта

LANDING_ID_INDEX
integer

Идентификатор страницы сайта, которая будет главной

LANDING_ID_404
integer

Идентификатор страницы ошибки 404

LANDING_ID_503
integer

Идентификатор страницы ошибки 503

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

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 206,
            "fields": {
              "TITLE": "Support portal",
              "CODE": "support-portal",
              "DESCRIPTION": "Обновленное описание сайта",
              "LANDING_ID_INDEX": 987
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.site.update.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 206,
            "fields": {
              "TITLE": "Support portal",
              "CODE": "support-portal",
              "DESCRIPTION": "Обновленное описание сайта",
              "LANDING_ID_INDEX": 987
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.site.update.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'landing.site.update',
        		{
        			id: 206,
        			fields: {
        				TITLE: 'Support portal',
        				CODE: 'support-portal',
        				DESCRIPTION: 'Обновленное описание сайта',
        				LANDING_ID_INDEX: 987
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.site.update',
                    [
                        'id' => 206,
                        'fields' => [
                            'TITLE' => 'Support portal',
                            'CODE' => 'support-portal',
                            'DESCRIPTION' => 'Обновленное описание сайта',
                            'LANDING_ID_INDEX' => 987,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating site: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.site.update',
            {
                id: 206,
                fields: {
                    TITLE: 'Support portal',
                    CODE: 'support-portal',
                    DESCRIPTION: 'Обновленное описание сайта',
                    LANDING_ID_INDEX: 987
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.site.update',
            [
                'id' => 206,
                'fields' => [
                    'TITLE' => 'Support portal',
                    'CODE' => 'support-portal',
                    'DESCRIPTION' => 'Обновленное описание сайта',
                    'LANDING_ID_INDEX' => 987,
                ],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Ошибка: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1773288229,
                "finish": 1773288229.999823,
                "duration": 0.9998230934143066,
                "processing": 0,
                "date_start": "2026-03-12T07:03:49+03:00",
                "date_finish": "2026-03-12T07:03:49+03:00",
                "operating_reset_at": 1773288829,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
boolean

true, если сайт успешно обновлен

time
time

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

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

HTTP-статус: 400

{
            "error": "MISSING_PARAMS",
            "error_description": "Недостаточно параметров вызова, пропущены: id"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

MISSING_PARAMS

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

ACCESS_DENIED

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

DOMAIN_NOT_FOUND

Указан несуществующий домен

DOMAIN_IS_INCORRECT

Передан некорректный формат доменного имени

DOMAIN_EXIST_TRASH

Домен уже привязан к сайту в корзине

DOMAIN_DISABLE

Нельзя использовать запрещенное имя домена в Битрикс24

DOMAIN_EXIST

Домен уже занят

CODE_IS_NOT_UNIQUE

Код сайта не уникален в рамках домена

SLASH_IS_NOT_ALLOWED

В fields.CODE передан символ /

CONTROLLER_ERROR_BADRESPONSE

Неопознанный ответ внешнего сервиса регистрации домена

CONTROLLER_ERROR_BADLICENSE

Ошибка лицензии во внешнем сервисе регистрации домена

CONTROLLER_ERROR_<ERROR_CODE>

Ошибка внешнего сервиса регистрации домена с кодом <ERROR_CODE>

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

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

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

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

Предыдущая
Снять сайт с публикации
Следующая
Изменить папку в сайте