Update Site landing.site.update

Scope: landing

Who can execute the method: a user with "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

id*
integer

Site identifier.

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

fields*
object

A set of fields to update the site (detailed description)

Parameter fields

Name `type`	Description
TITLE `string`	Site title, up to `255` characters long.
CODE `string`	Symbolic code of the site. When 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`. The maximum length of the code is `253` characters. If the code is already taken in the domain, a numeric suffix is automatically added to it.
TYPE `string`	Type of the site. Supported types are `PAGE`, `STORE`, `SMN`, `KNOWLEDGE`, `GROUP`, `MAINPAGE`. This is the internal type of the landing page, which is associated with the internal `scope`. The `scope` parameter is not passed in `landing.site.update` (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 passed, the parameter value is ignored. For `GROUP`, `KNOWLEDGE`, and `MAINPAGE`, the parameter is usually not passed. For 1C-Bitrix: Site Management, pass the identifier of an existing domain. The 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 long.
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.

Page identifiers for 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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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"

try
        {
        	const response = await $b24.callMethod(
        		'landing.site.update',
        		{
        			id: 206,
        			fields: {
        				TITLE: 'Support portal',
        				CODE: 'support-portal',
        				DESCRIPTION: 'Updated site 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' => '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>';
        }

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 may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

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`	It is not allowed to use a prohibited domain name 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: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Unpublish Site

Update Folder in Site

Update Site landing.site.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning