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:
landingWho 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 |
Description |
|
scope |
Internal scope of the landing. It is not related to the REST scope The value of |
|
lid* |
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* |
Identifier of the block. The block identifier can be obtained using the method landing.block.getList with the parameter |
|
meta |
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 |
Description |
|
name |
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 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 |
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 |
|
tpl_code |
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 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 |
Description |
|
result |
Identifier of the saved block copy |
|
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 |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
Required parameter |
|
|
Incorrect type provided for parameter |
|
|
Page not found or not accessible to the current user. The error may relate to both the |
|
|
Block with identifier |
|
|
Failed to create a copy of the block in the block repository |
|
|
Block version is not supported by the current version of the product |
|
|
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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
- Add Block to Page landing.landing.addblock
- Copy Block to Page landing.landing.copyblock
- Delete Block from Page landing.landing.deleteblock
- Move Block Down landing.landing.downblock
- Hide Block on Page landing.landing.hideblock
- Mark a Block as Deleted landing.landing.markdeletedblock
- Remove the deletion mark from the block landing.landing.markundeletedblock
- Move Block to Page landing.landing.moveblock
- Show Block on Page landing.landing.showblock
- Remove from the saved list of blocks landing.landing.unFavoriteBlock
- Move Block Up landing.landing.upblock