Remove Blocks and Clear Image File Bindings on Page landing.landing.removeEntities
Scope:
landingWho can execute the method: a user with "edit" access permission for the site
The method landing.landing.removeEntities removes specified blocks and their associated images from the page. It can also clear file bindings for individual images without deleting the blocks themselves.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
lid* |
Page identifier. 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 |
|
data* |
A set of objects to be removed (detailed description). If no blocks or images are specified for removal, the page will remain unchanged. However, the method will still return |
Parameter data
|
Name |
Description |
|
blocks |
Identifiers of the page blocks to be completely removed. For each block, the method also deletes all associated images. If the list includes blocks that are not present on the page or blocks that the user cannot delete, the method will skip them. For an existing accessible page, it may return |
|
images |
Pairs of block and image identifiers for removing file bindings. The content of the block remains unchanged — use this when the image has already been removed from the block and you need to clear the remaining service record. (detailed description). The method will not return a separate error in three cases: if the block is not found, if it is already specified in the |
Parameter images
Required parameters are marked with *
|
Name |
Description |
|
block* |
Identifier of the block associated with the image file binding |
|
image* |
Internal identifier of the image file binding ( For existing images, |
Code Examples
How to Use Examples in Documentation
This example demonstrates a mixed scenario: blocks from blocks are completely removed, while images elements clear file bindings for images in other blocks.
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"lid": 648,
"data": {
"blocks": [12167, 123],
"images": [
{
"block": 12269,
"image": 6866
},
{
"block": 12268,
"image": 6861
}
]
}
}' \
"https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.landing.removeEntities.json"
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"lid": 648,
"data": {
"blocks": [12167, 123],
"images": [
{
"block": 12269,
"image": 6866
},
{
"block": 12268,
"image": 6861
}
]
},
"auth": "**put_access_token_here**"
}' \
"https://**put.your-domain-here**/rest/landing.landing.removeEntities.json"
try
{
const response = await $b24.callMethod(
'landing.landing.removeEntities',
{
lid: 648,
data: {
blocks: [12167, 123],
images: [
{
block: 12269,
image: 6866
},
{
block: 12268,
image: 6861
}
]
}
}
);
const result = response.getData().result;
console.info(result);
}
catch (error)
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'landing.landing.removeEntities',
[
'lid' => 648,
'data' => [
'blocks' => [12167, 123],
'images' => [
[
'block' => 12269,
'image' => 6866,
],
[
'block' => 12268,
'image' => 6861,
],
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . var_export($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error removing blocks and images: ' . $e->getMessage();
}
BX24.callMethod(
'landing.landing.removeEntities',
{
lid: 648,
data: {
blocks: [12167, 123],
images: [
{
block: 12269,
image: 6866
},
{
block: 12268,
image: 6861
}
]
}
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'landing.landing.removeEntities',
[
'lid' => 648,
'data' => [
'blocks' => [12167, 123],
'images' => [
[
'block' => 12269,
'image' => 6866,
],
[
'block' => 12268,
'image' => 6861,
],
],
],
]
);
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": 1773796328,
"finish": 1773796328.413521,
"duration": 0.41352105140686035,
"processing": 0,
"date_start": "2026-03-18T04:12:08+01:00",
"date_finish": "2026-03-18T04:12:08+01:00",
"operating_reset_at": 1773796928,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Result of the removal, returns |
|
time |
Information about the execution time of the request |
Error Handling
HTTP Status: 400
{
"error": "LANDING_NOT_EXIST",
"error_description": "Landing not found"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
Required parameters are not provided: the request is missing |
|
|
The page is not found, deleted, or inaccessible to the current user |
|
|
Data type error in the method call parameters |
|
|
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 |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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
- Delete Page landing.landing.delete
- Mark Page as Deleted landing.landing.markDelete
- Restore Page from Recycle Bin landing.landing.markUnDelete
- Move Page landing.landing.move
- Publish Page landing.landing.publication
- Update Page landing.landing.update