Update Site landing.site.update

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: landing

Who can execute the method: a user with the "modify settings" access permission for the site

The method landing.site.update updates the parameters of the site.

Method Parameters

Required parameters are marked with *

Name
type

Description

scope
string

Internal scope of the landing. It is not related to the REST scope landing in the method name.

The value of scope must correspond to the type of site (detailed description)

id*
integer

Identifier of the site.

The site identifier can be obtained using the landing.site.getList method or from the result of the landing.site.add method

fields*
object

Set of fields to update the site (detailed description)

Fields Parameter

Name
type

Description

TITLE
string

Title of the site, up to 255 characters

CODE
string

Symbolic code of the site. If an empty string is passed, the code is generated from TITLE or from the string site.

The code cannot contain /, and a code consisting solely of digits receives the prefix site, with a maximum length of 253 characters.

If the code is already taken in the domain, a numeric suffix is automatically added

TYPE
string

Type of the site. Supported types are PAGE, STORE, SMN, KNOWLEDGE, GROUP, MAINPAGE.

This is the internal type of the landing, related to the internal scope (detailed description)

DOMAIN_ID
integer | string

Domain of the site. Usually, the domain name is passed. For sites of types PAGE, STORE, SMN, if the parameter is not passed or an empty string is provided, the parameter value is ignored. For GROUP, KNOWLEDGE, and MAINPAGE, the parameter is usually not passed.

For 1C-Bitrix: Site Management, provide the identifier of an existing domain. A domain name as a string is not supported, and the method will return an error

DESCRIPTION
string

Description of the site, up to 255 characters

XML_ID
string

External identifier of the site

LANDING_ID_INDEX
integer

Identifier of the site page that will be the main one

LANDING_ID_404
integer

Identifier of the 404 error page

LANDING_ID_503
integer

Identifier of the 503 error page

Identifiers for the pages LANDING_ID_INDEX, LANDING_ID_404, and LANDING_ID_503 can be obtained using the landing.landing.getList method.

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 206,
            "fields": {
              "TITLE": "Support portal",
              "CODE": "support-portal",
              "DESCRIPTION": "Updated site 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": "Updated site description",
              "LANDING_ID_INDEX": 987
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.site.update.json"
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<boolean>({
            method: 'landing.site.update',
            params: {
              id: 206,
              fields: {
                TITLE: 'Support portal',
                CODE: 'support-portal',
                DESCRIPTION: 'Updated site description',
                LANDING_ID_INDEX: 987,
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Site updated:', result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function updateSite() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'landing.site.update',
                params: {
                  id: 206,
                  fields: {
                    TITLE: 'Support portal',
                    CODE: 'support-portal',
                    DESCRIPTION: 'Updated site description',
                    LANDING_ID_INDEX: 987,
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Site updated:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateSite)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.landing.site.update(
                bitrix_id=206,
                fields={
                    "TITLE": "Support portal",
                    "CODE": "support-portal",
                    "DESCRIPTION": "Updated site description",
                    "LANDING_ID_INDEX": 987,
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.site.update',
                    [
                        'id' => 206,
                        'fields' => [
                            'TITLE' => 'Support portal',
                            'CODE' => 'support-portal',
                            'DESCRIPTION' => 'Updated site 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: 'Updated site 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' => 'Updated site description',
                    'LANDING_ID_INDEX' => 987,
                ],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Error: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "landing.site.update", b24.Params{
        	"id": 206,
        	"fields": b24.Params{
        		"TITLE":            "Support portal",
        		"CODE":             "support-portal",
        		"DESCRIPTION":      "Updated site description",
        		"LANDING_ID_INDEX": 987,
        	},
        })
        if err != nil {
        	return fmt.Errorf("landing.site.update: %w", err)
        }
        
        var ok bool
        if err := json.Unmarshal(res.Result, &ok); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("done:", ok)
        

Response Handling

HTTP Status: 200

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

Returned Data

Name
type

Description

result
boolean

true if the site was successfully updated

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "MISSING_PARAMS",
            "error_description": "Not enough parameters provided, missing: id"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

MISSING_PARAMS

Required parameter id or fields is missing

ACCESS_DENIED

Insufficient rights to modify the site or specific fields

DOMAIN_NOT_FOUND

A non-existent domain was specified

DOMAIN_IS_INCORRECT

An incorrect format of the domain name was provided

DOMAIN_EXIST_TRASH

The domain is already linked to a site in the trash

DOMAIN_DISABLE

A prohibited domain name cannot be used in Bitrix24

DOMAIN_EXIST

The domain is already occupied

CODE_IS_NOT_UNIQUE

The site code is not unique within the domain

SLASH_IS_NOT_ALLOWED

The character / was passed in fields.CODE

CONTROLLER_ERROR_BADRESPONSE

Unrecognized response from the external domain registration service

CONTROLLER_ERROR_BADLICENSE

License error in the external domain registration service

CONTROLLER_ERROR_<ERROR_CODE>

Error from the external domain registration service with code <ERROR_CODE>

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

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

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning