Save to the list of blocks landing.landing.favoriteBlock

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 "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

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)

lid*
integer

Identifier of the page.

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

block*
integer

Identifier of the block.

The block identifier can be obtained using the method landing.block.getList 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 custom name of the saved copy. It does not replace the standard name of the block. If the parameter is not provided, the original name of the block 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 method landing.block.getrepository. 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.

Pass the ID of the file with the image, pre-uploaded using the method landing.block.uploadfile for the original block. The method saves this ID as the preview of the saved block copy.

If the file is already linked to the original block as a custom 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 custom 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 method landing.landing.getList.

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 -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "lid": 351,
            "block": 6428,
            "meta": {
              "name": "Block with Advantages",
              "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 Advantages",
              "section": ["text", "features"],
              "preview": 918273,
              "tpl_code": "bitrix24"
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.landing.favoriteBlock.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<number>({
            method: 'landing.landing.favoriteBlock',
            params: {
              lid: 351,
              block: 6428,
              meta: {
                name: 'Block with advantages',
                section: ['text', 'features'],
                preview: 918273,
                tpl_code: 'bitrix24',
              },
            },
            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('Saved block copy ID:', 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 saveFavoriteBlock() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'landing.landing.favoriteBlock',
                params: {
                  lid: 351,
                  block: 6428,
                  meta: {
                    name: 'Block with advantages',
                    section: ['text', 'features'],
                    preview: 918273,
                    tpl_code: 'bitrix24',
                  },
                },
                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('Saved block copy ID:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', saveFavoriteBlock)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.landing.landing.favorite_block(
                lid=351,
                block=6428,
                meta={
                    "name": "Block with advantages",
                    "section": [
                        "text",
                        "features",
                    ],
                    "preview": 918273,
                    "tpl_code": "bitrix24",
                },
            ).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.landing.favoriteBlock',
                    [
                        'lid' => 351,
                        'block' => 6428,
                        'meta' => [
                            'name' => 'Block with Advantages',
                            '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 Advantages',
                    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 Advantages',
                    '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>';
        }
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "landing.landing.favoriteBlock", b24.Params{
        	"lid":   351,
        	"block": 6428,
        	"meta": b24.Params{
        		"name":     "Block with Advantages",
        		"section":  []string{"text", "features"},
        		"preview":  918273,
        		"tpl_code": "bitrix24",
        	},
        })
        if err != nil {
        	return fmt.Errorf("landing.landing.favoriteBlock: %w", err)
        }
        
        var value b24.ID
        if err := json.Unmarshal(res.Result, &value); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("result:", value)
        

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+01:00",
                "date_finish": "2026-03-20T01:16:49+01: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 execution time of the request

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 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 lid or block is missing

TYPE_ERROR

Incorrect type provided for parameter lid, block, or meta

LANDING_NOT_EXIST

Page not found or not accessible to the current user. The error may relate 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 not available for copying. If the page to which the block belongs is not found, the method typically 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 is not supported by the current version of the product

ACCESS_DENIED

Insufficient rights to modify the block

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