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

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 View access permission in the Sites and Stores 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 -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"
        
// 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.repo.register',
            params: {
              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' },
                },
              },
            },
            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('Registered block 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 registerBlock() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'landing.repo.register',
                params: {
                  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' },
                    },
                  },
                },
                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('Registered block id:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', registerBlock)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.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",
                        },
                    },
                },
            ).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.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>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "landing.repo.register", b24.Params{
        	"code": "myblockx",
        	"fields": b24.Params{
        		"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": b24.Params{
        		"block": b24.Params{
        			"name": "Test block",
        		},
        		"nodes": b24.Params{
        			".landing-block-node-text": b24.Params{
        				"name": "Text",
        				"type": "text",
        			},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("landing.repo.register: %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": 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 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

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