Save to the block list landing.landing.favoriteBlock

Scope: landing

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

The method landing.landing.favoriteBlock creates a copy of a page block and saves it to the block list as a template. Upon successful execution, the method returns the identifier of the new block copy.

Method Parameters

Required parameters are marked with *

Name `type`	Description
lid* `integer`	Page identifier. 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
block* `integer`	Block identifier. The block identifier can be obtained using the landing.block.getList method with the parameter `params.edit_mode = 1`
meta `object`	Parameters of the saved block (detailed description). If the parameter is not provided, the method saves a copy of the block without additional overrides

Parameter meta

Name `type`	Description
name `string`	Name of the saved block copy in the block list. This is the user-defined name of the saved copy. It does not replace the standard name of the block. If the parameter is not provided, the original block name is used
section `array` \| `string`	Section or list of sections where the saved block will be displayed. If the parameter is not provided, the block will be shown in the same sections as the original block. You can use section codes from the landing.block.getrepository method. If you provide a code that does not exist in the standard repository, a separate section will be created for it
preview `integer`	Identifier of the preview image file. Provide the file ID of the image that has been pre-uploaded using the landing.block.uploadfile method for the original block. The method saves this ID as the preview for the saved block copy. If the file is already linked to the original block as a user preview, this link will only change after the method successfully completes. If the method fails, the link to the original block will not change. If the parameter is not provided or equals `0`, the user preview is not saved
tpl_code `string`	Template code of the page to which the saved block should be linked. Providing this parameter is equivalent to checking the "Link to current style" checkbox in the editor. The value can be taken from the `TPL_CODE` field of the page, for example from the response of the landing.landing.getList method. This parameter is saved along with the metadata of the saved block and is used by the editor when working with such blocks. If the parameter is not provided, no special link to the template code is saved

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": 351,
            "block": 6428,
            "meta": {
              "name": "Block with Benefits",
              "section": ["text", "features"],
              "preview": 918273,
              "tpl_code": "bitrix24"
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.landing.favoriteBlock.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "lid": 351,
            "block": 6428,
            "meta": {
              "name": "Block with Benefits",
              "section": ["text", "features"],
              "preview": 918273,
              "tpl_code": "bitrix24"
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.landing.favoriteBlock.json"

try
        {
            const response = await $b24.callMethod(
                'landing.landing.favoriteBlock',
                {
                    lid: 351,
                    block: 6428,
                    meta: {
                        name: 'Block with Benefits',
                        section: ['text', 'features'],
                        preview: 918273,
                        tpl_code: 'bitrix24'
                    }
                }
            );
        
            const result = response.getData().result;
            console.info('ID of the saved copy:', result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.landing.favoriteBlock',
                    [
                        'lid' => 351,
                        'block' => 6428,
                        'meta' => [
                            'name' => 'Block with Benefits',
                            'section' => ['text', 'features'],
                            'preview' => 918273,
                            'tpl_code' => 'bitrix24',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error saving block to the block list: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.landing.favoriteBlock',
            {
                lid: 351,
                block: 6428,
                meta: {
                    name: 'Block with Benefits',
                    section: ['text', 'features'],
                    preview: 918273,
                    tpl_code: 'bitrix24'
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info('ID of the saved copy:', result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'landing.landing.favoriteBlock',
            [
                'lid' => 351,
                'block' => 6428,
                'meta' => [
                    'name' => 'Block with Benefits',
                    'section' => ['text', 'features'],
                    'preview' => 918273,
                    'tpl_code' => 'bitrix24',
                ],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Error: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

Response Handling

HTTP Status: 200

{
            "result": 28619,
            "time": {
                "start": 1773958609,
                "finish": 1773958609.566006,
                "duration": 0.5660059452056885,
                "processing": 0,
                "date_start": "2026-03-20T01:16:49+02:00",
                "date_finish": "2026-03-20T01:16:49+02:00",
                "operating_reset_at": 1773959209,
                "operating": 0.21611928939819336
            }
        }

Returned Data

Name `type`	Description
result `integer`	Identifier of the saved block copy
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "BLOCK_NOT_FOUND",
            "error_description": "Block not found in the landing"
        }

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` or `block` is missing
`TYPE_ERROR`	Incorrect type provided for parameter `lid`, `block`, or `meta`
`LANDING_NOT_EXIST`	Page not found or inaccessible to the current user. The error may refer to both the `lid` page and the page to which the copied block belongs
`BLOCK_NOT_FOUND`	Block with identifier `block` not found among the blocks of the original page or inaccessible for copying. If the page to which the block belongs is not found, the method usually returns `LANDING_NOT_EXIST`
`BLOCK_CANT_BE_ADDED`	Failed to create a copy of the block in the block repository
`BLOCK_WRONG_VERSION`	Block version not supported by the current version of the product
`ACCESS_DENIED`	Insufficient rights to modify the block

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

Move Block Down

Hide Block on Page

Save to the block list landing.landing.favoriteBlock

Method ParametersMethod Parameters

Parameter metaParameter meta

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