Copy Block to Page landing.landing.copyblock

Scope: landing

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

The method landing.landing.copyblock copies a block to the specified page and returns the identifier of the created block copy. You can copy a block from another page or within the same page. The HTML content of the block is also copied.

Method Parameters

Required parameters are marked with *

Name
type

Description

lid*
integer

Identifier of the page to which the block should be copied.

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 source block.

The block identifier can be obtained using the method landing.block.getList. The block can be on another page or on the same page lid.

You can only copy an existing block that is not marked as deleted. If the block is deleted, the method will return an error

params
object

Additional copy parameters (detailed description)

Parameter params

Name
type

Description

AFTER_ID
integer

Identifier of the block on the page lid, after which the copy should be inserted

If you pass the identifier of an existing block on the page lid, the copy will be inserted immediately after it. If the parameter is not passed, 0 is passed, or the identifier of a block that does not exist on the page lid is specified, the copy will be added to the end of the page

RETURN_CONTENT
string

If Y is passed, the method will return an object with a success indicator and the data of the created block copy (detailed description). For any other value, the method will return only the identifier of the created block copy

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "lid": 351,
            "block": 6428,
            "params": {
              "AFTER_ID": 6429,
              "RETURN_CONTENT": "Y"
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.landing.copyblock.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "lid": 351,
            "block": 6428,
            "params": {
              "AFTER_ID": 6429,
              "RETURN_CONTENT": "Y"
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.landing.copyblock.json"
        
try
        {
            const response = await $b24.callMethod(
                'landing.landing.copyblock',
                {
                    lid: 351,
                    block: 6428,
                    params: {
                        AFTER_ID: 6429,
                        RETURN_CONTENT: 'Y'
                    }
                }
            );
        
            const result = response.getData().result;
            console.info(result);
        }
        catch (error)
        {
            console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.landing.copyblock',
                    [
                        'lid' => 351,
                        'block' => 6428,
                        'params' => [
                            'AFTER_ID' => 6429,
                            'RETURN_CONTENT' => 'Y',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.landing.copyblock',
            {
                lid: 351,
                block: 6428,
                params: {
                    AFTER_ID: 6429,
                    RETURN_CONTENT: 'Y'
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.landing.copyblock',
            [
                'lid' => 351,
                'block' => 6428,
                'params' => [
                    'AFTER_ID' => 6429,
                    'RETURN_CONTENT' => 'Y',
                ],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Error: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }
        

Response Handling

HTTP status: 200

{
            "result": 28607,
            "time": {
                "start": 1773932480,
                "finish": 1773932480.485875,
                "duration": 0.48587489128112793,
                "processing": 0,
                "date_start": "2026-03-19T18:01:20+02:00",
                "date_finish": "2026-03-19T18:01:20+02:00",
                "operating_reset_at": 1773933080,
                "operating": 0
            }
        }
        

If params.RETURN_CONTENT = 'Y' is passed, instead of the block identifier, the method will return an object with a success indicator and the data of the created block copy.

Example Response with RETURN_CONTENT = 'Y'

{
            "result": {
                "result": true,
                "content": {
                    "id": 28607,
                    "sections": "text_image,about",
                    "active": true,
                    "access": "X",
                    "anchor": "b28607",
                    "php": false,
                    "designed": false,
                    "repoId": null,
                    "content": "<div id=\"block28607\" data-id=\"28607\" class=\"block-wrapper block-19-2-features-with-img\">...</div>",
                    "content_ext": "",
                    "css": [],
                    "js": [
                        "/bitrix/js/pull/protobuf/protobuf.js?1592315491274055",
                        "/bitrix/js/pull/protobuf/model.min.js?159231549114190",
                        "/bitrix/js/main/core/core_promise.min.js?17647596972494",
                        "/bitrix/js/rest/client/rest.client.min.js?16015491189240",
                        "/bitrix/js/pull/client/pull.client.min.js?174471771449849"
                    ],
                    "assetStrings": [],
                    "lang": [],
                    "manifest": {
                        "block": {
                            "name": "Text with Icon Points and Image on the Left",
                            "section": [
                                "text_image",
                                "about"
                            ]
                        },
                        "timestamp": 1751467642,
                        "namespace": "bitrix",
                        "code": "19.2.features_with_img",
                        "preview": "/bitrix/blocks/bitrix/19.2.features_with_img/preview.jpg"
                    },
                    "dynamicParams": []
                }
            },
            "time": {
                "start": 1773933164,
                "finish": 1773933164.48191,
                "duration": 0.48190999031066895,
                "processing": 0,
                "date_start": "2026-03-19T18:12:44+02:00",
                "date_finish": "2026-03-19T18:12:44+02:00",
                "operating_reset_at": 1773933764,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
integer | object

Identifier of the created block copy. If params.RETURN_CONTENT = 'Y' is passed, the method will return an object with a success indicator and block data (detailed description)

time
time

Information about the execution time of the request

Object result with RETURN_CONTENT = 'Y'

Name
type

Description

result
boolean

Indicator of successful copying. Returns true upon successful execution

content
object

Data of the created block copy (detailed description)

Object content

Name
type

Description

id
integer

Identifier of the created block copy

sections
string

Codes of the block sections from the manifest, concatenated into a single string separated by commas

active
boolean

Indicator of the block's activity

access
string

Access level to the block. Possible values:
A — access closed to all blocks,
D — access denied,
V — can only edit design,
W — can edit content and design without deletion,
X — full access

anchor
string

Local anchor of the block. The new block always receives an anchor of the form b<ID>, for example b28607

php
boolean

Indicator that there is PHP code in the block's content

designed
boolean

Indicator of a designed block

repoId
integer

Identifier of the REST block from the repository or null if the block is not linked to a REST repository

content
string

Prepared HTML code of the block

content_ext
string

Additional HTML code of connected extensions

css
array

List of CSS resources for the block. If there are no separate CSS connections for the block, an empty array is returned

js
array

List of JS resources for the block and related client libraries that need to be connected for its operation.

For REST blocks of the type repo_<ID>, this field returns an empty array

assetStrings
array

Initialization strings for resources that need to be added to the page

lang
array | object

Language messages of connected extensions. If messages exist, this field is returned as a key-value object. If there are no additional messages, it may return an empty array

manifest
object

The complete manifest of the block. The format is described in the section Block Manifest

dynamicParams
array

Parameters of the dynamic block from SOURCE_PARAMS.

For regular static blocks, this field usually returns an empty array

requiredUserAction
array

This field contains the same data as manifest.requiredUserAction. It is returned only when the user must perform additional actions on the client side after copying the block

Error Handling

HTTP status: 400 Bad Request

{
            "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 not provided

LANDING_NOT_EXIST

Page with identifier lid not found or not accessible to the current user

ACCESS_DENIED

User does not have permission to call landing methods or does not have permission to edit page lid

BLOCK_NOT_FOUND

Source block with identifier block not found, not accessible to the current user, marked as deleted, or cannot be loaded from the source page

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