Update Page landing.landing.update

Scope: landing

Who can execute the method: a user with the "change settings" access permission for the site. To delete the page or change its publication date, additional "delete" and "publication" permissions are required on the site.

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

Method Parameters

Required parameters are marked with *

Name
type

Description

lid*
integer

The identifier of the page to be updated.

The page identifier can be obtained using the landing.landing.getList method, as well as from the results of the landing.landing.add, landing.landing.addByTemplate, and landing.landing.copy methods.

fields*
object

A set of fields for the page to be updated (detailed description)

Parameter fields

Name
type

Description

TITLE
string

The title of the page.

CODE
string

The symbolic code of the page. The code cannot contain the character / and must not be in the format <letters, digits or _>_<number>_<number>, for example code_12_34.

If an empty string is passed and the FOLDER field is not specified, the method will return an error. If the FOLDER field is passed with any value, there will be no error.

DESCRIPTION
string

A free-form description of the page.

XML_ID
string

The external identifier of the page.

SITE_ID
integer

The identifier of the site to which the page should be linked. If the parameter is not passed, the current site of the page is used.

If both a new site and a folder are specified, the folder will be checked not in the new site but in the current site of the page. For such a scenario, it is better to use landing.landing.move.

SITEMAP
string

A flag to include the page in the sitemap. Supported values are Y and N. Any other value will be saved as N.

FOLDER
string

A folder indicator. Supported values are Y and N. Any other value will be saved as N.

FOLDER_ID
integer

The identifier of the folder in which to place the page. The folder must be within the current site of the page. If 0 is passed, the page will be moved to the root of the site.

The folder identifier can be obtained using the landing.site.getFolders method.

TPL_ID
integer

The identifier of the page view template.

The template identifier can be obtained using the landing.template.getlist method.

DELETED
string

Manages the state of the page in the trash. When this field is passed, the page becomes inactive.

Y — the page is moved to the trash and becomes inactive.
N — the page is restored from the trash but remains inactive until it is published separately.

For deleting and restoring the page, it is better to use the methods landing.landing.markDelete and landing.landing.markUnDelete.

If the page is set as the main page in the site settings and there are other undeleted pages in this site, the method will return the error CANT_DELETE_MAIN.

DATE_PUBLIC
string

The date and time of the page publication.

To change this field, the "publication" permission on the site is required. Changing the field does not publish the page but only updates the publication date.

For publishing and unpublishing, use the methods landing.landing.publication and landing.landing.unpublic.

ADDITIONAL_FIELDS
object

Additional fields of the page. Available codes and values are described in the article Additional Page Fields.

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "lid": 349,
            "fields": {
              "TITLE": "Spring Sale 2026",
              "CODE": "spring-sale-2026",
              "DESCRIPTION": "Updated description of the promotion page",
              "XML_ID": "promo-2026-landing"
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.landing.update.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "lid": 349,
            "fields": {
              "TITLE": "Spring Sale 2026",
              "CODE": "spring-sale-2026",
              "DESCRIPTION": "Updated description of the promotion page",
              "XML_ID": "promo-2026-landing"
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.landing.update.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'landing.landing.update',
        		{
        			lid: 349,
        			fields: {
        				TITLE: 'Spring Sale 2026',
        				CODE: 'spring-sale-2026',
        				DESCRIPTION: 'Updated description of the promotion page',
        				XML_ID: 'promo-2026-landing'
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.landing.update',
                    [
                        'lid' => 349,
                        'fields' => [
                            'TITLE' => 'Spring Sale 2026',
                            'CODE' => 'spring-sale-2026',
                            'DESCRIPTION' => 'Updated description of the promotion page',
                            'XML_ID' => 'promo-2026-landing',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating page: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.landing.update',
            {
                lid: 349,
                fields: {
                    TITLE: 'Spring Sale 2026',
                    CODE: 'spring-sale-2026',
                    DESCRIPTION: 'Updated description of the promotion page',
                    XML_ID: 'promo-2026-landing'
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.landing.update',
            [
                'lid' => 349,
                'fields' => [
                    'TITLE' => 'Spring Sale 2026',
                    'CODE' => 'spring-sale-2026',
                    'DESCRIPTION' => 'Updated description of the promotion page',
                    'XML_ID' => 'promo-2026-landing',
                ],
            ]
        );
        
        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": 1773835076,
                "finish": 1773835076.29,
                "duration": 0.28999996185302734,
                "processing": 0,
                "date_start": "2026-03-18T14:57:56+02:00",
                "date_finish": "2026-03-18T14:57:56+02:00",
                "operating_reset_at": 1773835676,
                "operating": 0.1001579761505127
            }
        }
        

Returned Data

Name
type

Description

result
boolean

The result of the update. Returns true on success.

time
time

Information about the execution time of the request.

Error Handling

HTTP Status: 400

{
            "error": "MISSING_PARAMS",
            "error_description": "Not enough call parameters, missing: lid"
        }
        

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

The required parameter lid or fields is missing.

ACCESS_DENIED

Insufficient permissions to modify the page or a specific field. For example, for fields.DELETED, the "delete" permission on the site is required, and for fields.DATE_PUBLIC, the "publication" permission on the site is required.

SITE_NOT_FOUND

An identifier of a non-existent site is passed in fields.SITE_ID.

FOLDER_NOT_FOUND

A folder that does not belong to the current site of the page or does not exist is passed in fields.FOLDER_ID.

SLASH_IS_NOT_ALLOWED

The character / is passed in fields.CODE.

CANT_BE_EMPTY

An empty string '' is passed in fields.CODE, and the fields.FOLDER key is absent in the same request.

WRONG_CODE_FORMAT

A value in the format <letters, digits or _>_<number>_<number> is passed in fields.CODE, for example code_12_34 or my_page_1_2.

CANT_DELETE_MAIN

Cannot mark the main page of the site as deleted if there are other undeleted pages in the site.

TYPE_ERROR

Data type error in the method call parameters.

SYSTEM_ERROR

Internal error during method execution.

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