Add a Custom Block to the Repository landing.repo.register

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: landing

Who can execute the method: a user with View access permission in the Sites section

The method landing.repo.register adds a new custom block to the repository.

The method updates the block if it already exists with the same code for the current application. If it does not exist, it creates a new one.

Method Parameters

Required parameters are marked with *

Name `type`	Description
code^* `string`	Unique block code
fields^* `object`	Block fields more details
manifest `object`	Block manifest. See the structure of the manifest in the method landing.block.getManifestFile and in the section Manifest File

Type fields

Required parameters are marked with *

Name `type`	Description
NAME^* `string`	Block name
CONTENT^* `string`	HTML content of the block. It undergoes a sanitize check before saving
SECTIONS^* `string`	Block categories as a comma-separated string, e.g., `cover,about`
PREVIEW^* `string`	Block preview URL
DESCRIPTION `string`	Block description
ACTIVE `string`	Block activity (`Y`/`N`)
SITE_TEMPLATE_ID `string`	Binding of the block to the site template
RESET `string`	If `Y` is passed, the method registers updates for blocks added to pages with the code `repo_<ID>`

Code Examples

How to Use Examples in Documentation

Example of registering a block where:

code — unique block code myblockx
fields — main parameters of the block (NAME, DESCRIPTION, SECTIONS, PREVIEW, CONTENT)
manifest — basic manifest of the block with the description of block and nodes

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "code": "myblockx",
            "fields": {
              "NAME": "Test block",
              "DESCRIPTION": "Just try!",
              "SECTIONS": "cover,about",
              "PREVIEW": "https://www.bitrix24.com/images/b24_screen.png",
              "CONTENT": "<section class=\"landing-block\"><div class=\"container\">Test</div></section>"
            },
            "manifest": {
              "block": {"name": "Test block"},
              "nodes": {
                ".landing-block-node-text": {"name": "Text", "type": "text"}
              }
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.repo.register.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "code": "myblockx",
            "fields": {
              "NAME": "Test block",
              "SECTIONS": "cover,about",
              "PREVIEW": "https://www.bitrix24.com/images/b24_screen.png",
              "CONTENT": "<section class=\"landing-block\"><div class=\"container\">Test</div></section>"
            },
            "manifest": {
              "block": {"name": "Test block"}
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.repo.register.json"

try
        {
        	const response = await $b24.callMethod(
        		'landing.repo.register',
        		{
        			code: 'myblockx',
        			fields: {
        				NAME: 'Test block',
        				DESCRIPTION: 'Just try!',
        				SECTIONS: 'cover,about',
        				PREVIEW: 'https://www.bitrix24.com/images/b24_screen.png',
        				CONTENT: '<section class="landing-block"><div class="container">Test</div></section>'
        			},
        			manifest: {
        				block: { name: 'Test block' },
        				nodes: {
        					'.landing-block-node-text': { name: 'Text', type: 'text' }
        				}
        			}
        		}
        	);
        
        	console.info(response.getData().result);
        }
        catch (error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.repo.register',
                    [
                        'code' => 'myblockx',
                        'fields' => [
                            'NAME' => 'Test block',
                            'DESCRIPTION' => 'Just try!',
                            'SECTIONS' => 'cover,about',
                            'PREVIEW' => 'https://www.bitrix24.com/images/b24_screen.png',
                            'CONTENT' => '<section class="landing-block"><div class="container">Test</div></section>',
                        ],
                        'manifest' => [
                            'block' => ['name' => 'Test block'],
                            'nodes' => [
                                '.landing-block-node-text' => ['name' => 'Text', 'type' => 'text'],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error calling landing.repo.register: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.repo.register',
            {
                code: 'myblockx',
                fields: {
                    NAME: 'Test block',
                    DESCRIPTION: 'Just try!',
                    SECTIONS: 'cover,about',
                    PREVIEW: 'https://www.bitrix24.com/images/b24_screen.png',
                    CONTENT: '<section class="landing-block"><div class="container">Test</div></section>'
                },
                manifest: {
                    block: { name: 'Test block' },
                    nodes: {
                        '.landing-block-node-text': { name: 'Text', type: 'text' }
                    }
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'landing.repo.register',
            [
                'code' => 'myblockx',
                'fields' => [
                    'NAME' => 'Test block',
                    'DESCRIPTION' => 'Just try!',
                    'SECTIONS' => 'cover,about',
                    'PREVIEW' => 'https://www.bitrix24.com/images/b24_screen.png',
                    'CONTENT' => '<section class="landing-block"><div class="container">Test</div></section>',
                ],
                'manifest' => [
                    'block' => ['name' => 'Test block'],
                ],
            ]
        );
        
        echo '<pre>';
        print_r($result);
        echo '</pre>';

Response Handling

HTTP Status: 200

{
            "result": 7,
            "time": {
                "start": 1774879194,
                "finish": 1774879194.526507,
                "duration": 0.5265069007873535,
                "processing": 0,
                "date_start": "2026-03-30T16:59:54+02:00",
                "date_finish": "2026-03-30T16:59:54+02:00",
                "operating_reset_at": 1774879794,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `integer`	Identifier of the added or updated block in the repository
time `time`	Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "MANIFEST_INTERSECT_IMG",
            "error_description": "The editable manifest element \".landing-block-node-text\" cannot have a style type of \"Image\". Change the style type."
        }

{
            "error": "ERROR_ARGUMENT",
            "error_description": "The value of an argument 'code' has an invalid type",
            "argument": "code"
        }

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	Value
`ACCESS_DENIED`	Insufficient permissions	User did not pass general access checks
`ERROR_ARGUMENT`	Invalid argument type	An argument was passed in an incorrect type. The name of the argument is returned in the `argument` field
`MISSING_PARAMS`	Insufficient call parameters	A required parameter (`code` or `fields`) was not passed
`REQUIRED_FIELD_NO_EXISTS`	Missing required field	One of the fields was not passed: `NAME`, `CONTENT`, `SECTIONS`, `PREVIEW`
`MANIFEST_INTERSECT_IMG`	Type conflict in the manifest	A `node` and a style with type `background`, `block-default`, or `block-border` are set for one selector
`CONTENT_IS_BAD`	Unsafe block content	The `fields.CONTENT` field did not pass the sanitize check
`PRESET_CONTENT_IS_BAD`	Unsafe preset content	Unsafe content in `manifest.cards[].presets[]`
`UNSUPPORTED_BLOCK_TYPE`	Unsupported block type	The method code checks the restriction on `MAINPAGE` in `manifest.block.type`
`UNSUPPORTED_BLOCK_SUBTYPE`	Unsupported block subtype	`widget` was passed in `manifest.block.subtype`
`insufficient_scope`	Insufficient scope for the token	The token does not contain the `landing` scope
`SYSTEM_ERROR`	Internal error	Execution error on the server side

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "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

Overview of Methods

Retrieve List of Blocks

Add a Custom Block to the Repository landing.repo.register

Method ParametersMethod Parameters

Type fieldsType fields

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