Register an Embedding Location landing.repo.bind

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: user with View access permission in the Sites section

Registers an embedding location for the current application in the Sites section.

The method works only in the context of an application.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

Embedding location parameters (detailed description)

The fields Parameter

Name
type

Description

PLACEMENT*
string

Embedding location code.

The code depends on where the application item should appear:

  • LANDING_SETTINGS — an item in the site or page settings menu
  • LANDING_BLOCK_<CODE> — an editing item for blocks with the specified symbolic code
  • LANDING_BLOCK_* — an editing item for all blocks

The method trims whitespace from the value and converts the code to uppercase

PLACEMENT_HANDLER*
string

Full HTTP or HTTPS address of the embedding location handler.

The address must include the protocol and domain name

TITLE
string

Application item name in the interface.

The default value is an empty string

Code Examples

How to Use Examples in Documentation

The example registers an application item in the site or page settings menu.

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "fields": {
              "PLACEMENT": "LANDING_SETTINGS",
              "PLACEMENT_HANDLER": "https://your-domain.com/widgets/landing-settings-handler.php",
              "TITLE": "My Settings"
            },
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/landing.repo.bind
        
import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<boolean>({
            method: 'landing.repo.bind',
            params: {
              fields: {
                PLACEMENT: 'LANDING_SETTINGS',
                PLACEMENT_HANDLER: 'https://your-domain.com/widgets/landing-settings-handler.php',
                TITLE: 'My Settings',
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            console.info(response.getData()!.result)
          }
        } catch (error) {
          console.error(error)
        }
        
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function bindLandingPlacement() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
              const response = await $b24.actions.v2.call.make({
                method: 'landing.repo.bind',
                params: {
                  fields: {
                    PLACEMENT: 'LANDING_SETTINGS',
                    PLACEMENT_HANDLER: 'https://your-domain.com/widgets/landing-settings-handler.php',
                    TITLE: 'My Settings',
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              console.info(response.getData().result)
            } catch (error) {
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', bindLandingPlacement)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        fields = {
            "PLACEMENT": "LANDING_SETTINGS",
            "PLACEMENT_HANDLER": "https://your-domain.com/widgets/landing-settings-handler.php",
            "TITLE": "My Settings",
        }
        
        try:
            bitrix_response = client.landing.repo.bind(fields=fields).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.bind',
                    [
                        'fields' => [
                            'PLACEMENT' => 'LANDING_SETTINGS',
                            'PLACEMENT_HANDLER' => 'https://your-domain.com/widgets/landing-settings-handler.php',
                            'TITLE' => 'My Settings',
                        ],
                    ]
                );
        
            $result = $response->getResponseData()->getResult();
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error binding landing placement: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.repo.bind',
            {
                fields: {
                    PLACEMENT: 'LANDING_SETTINGS',
                    PLACEMENT_HANDLER: 'https://your-domain.com/widgets/landing-settings-handler.php',
                    TITLE: 'My Settings'
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.repo.bind',
            [
                'fields' => [
                    'PLACEMENT' => 'LANDING_SETTINGS',
                    'PLACEMENT_HANDLER' => 'https://your-domain.com/widgets/landing-settings-handler.php',
                    'TITLE' => 'My Settings',
                ],
            ]
        );
        
        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.repo.bind", b24.Params{
        	"fields": b24.Params{
        		"PLACEMENT":         "LANDING_SETTINGS",
        		"PLACEMENT_HANDLER": "https://your-domain.com/widgets/landing-settings-handler.php",
        		"TITLE":             "My Settings",
        	},
        })
        if err != nil {
        	return fmt.Errorf("landing.repo.bind: %w", err)
        }
        
        var ok bool
        if err := json.Unmarshal(res.Result, &ok); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("done:", ok)
        

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1775203200,
                "finish": 1775203200.764211,
                "duration": 0.7642109394073486,
                "processing": 0,
                "date_start": "2026-04-03T11:00:00+02:00",
                "date_finish": "2026-04-03T11:00:00+02:00",
                "operating_reset_at": 1775203800,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
boolean

Registration result. Returns true if the record was added successfully

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "PLACEMENT_EXIST",
            "error_description": "Such embedding placement already exists"
        }
        

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

Status

Code

Description

Value

400

MISSING_PARAMS

Not enough parameters for the call, missing: fields

The fields parameter was not passed

400

TYPE_ERROR

Invalid call argument type: fields

The value passed in fields is not an object

400

ACCESS_DENIED

Insufficient permissions.

The user does not have View access permission in the Sites section or did not pass the general access checks for the landing module

400

ACCESS_DENIED

Only an application can manage embedding locations

The method was called outside the application context, or the rest module is unavailable

400

PLACEMENT_UNKNOWN

This embedding location is not available for sites

The PLACEMENT code does not start with LANDING_

400

PLACEMENT_HANDLER_INVALID

Invalid embedding location handler address

PLACEMENT_HANDLER contains an empty or invalid HTTP or HTTPS address

400

PLACEMENT_EXIST

Such embedding placement already exists

The current application already has an embedding location with the specified PLACEMENT and PLACEMENT_HANDLER

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