Change the Anchor of the Block landing.block.changeAnchor

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: landing

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

The method landing.block.changeAnchor modifies or removes a custom anchor of a block in the draft of a page.

If the page is already published, changes will be visible to visitors after publishing the updates through the interface or using the method landing.landing.publication.

Method Parameters

Required parameters are marked with *

Name `type`	Description
scope `string`	Internal scope of landings. 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)
lid* `integer`	Identifier of the page. The page identifier can be obtained using the method landing.landing.getList
block* `integer`	Identifier of the block in the draft of the page. The block identifier can be obtained using the method landing.block.getlist with the parameter `params.edit_mode = true`
data* `string`	New anchor of the block without the `#` symbol. Pass the value as a string. The anchor must start with a letter `A-Z` or `a-z`, contain at least two characters, and may include only letters `A-Z` and `a-z`, digits `0-9`, and symbols `-`, `_`, `.`, `:`. A single-character anchor is not allowed. For example, `a` will trigger an error. Examples of valid values: `about-us`, `Section_A`, `faq.v2`, `Tab:1`
preventHistory `boolean`	Do not add the change to the page history. Possible values: `true` — do not save the change in history, `false` — save the change in history. Default is `false`

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 '{
            "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 'Error: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

Response Handling

HTTP Status: 200

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

Returned Data

Name `type`	Description
result `boolean`	The result of changing the anchor. Upon successful execution, the method returns `true`
time `time`	Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "BAD_ANCHOR",
            "error_description": "The anchor must start with a character from a-z and may only contain characters from \"a-z\", \"0-9\", \"-\", \"_\", \".\", \":\""
        }

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 `lid`, `block`, or `data` is missing
`LANDING_NOT_EXIST`	The page with identifier `lid` was not found or is not accessible to the current user
`BLOCK_NOT_FOUND`	The block with identifier `block` was not found in the draft of the page
`ACCESS_DENIED`	Insufficient rights to edit the site
`BAD_ANCHOR`	An invalid anchor was provided: it does not start with a letter, contains forbidden characters, or consists of a single character

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "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

Add Card with Updated Content

Change Tag Name

Change the Anchor of the Block landing.block.changeAnchor

Method ParametersMethod Parameters

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