Bind Knowledge Base to Menu landing.site.bindingToMenu
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:
landingWho can execute the method: a user with View permission in the Sites section and Placement permission in the Extensions section of the Knowledge Base
The method landing.site.bindingToMenu binds the Knowledge Base to the specified menu.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the Knowledge Base site.
|
|
menuCode* |
Menu code.
|
Code Examples
How to Use Examples in Documentation
Example of binding the Knowledge Base to a menu, where:
id— identifier of the Knowledge Base sitemenuCode— menu code
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 31,
"menuCode": "crm_switcher:deal"
}' \
"https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.site.bindingToMenu.json"
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 31,
"menuCode": "crm_switcher:deal",
"auth": "**put_access_token_here**"
}' \
"https://**put.your-domain-here**/rest/landing.site.bindingToMenu.json"
try
{
const response = await $b24.callMethod(
'landing.site.bindingToMenu',
{
id: 31,
menuCode: 'crm_switcher:deal'
}
);
const result = response.getData().result;
console.info(result);
}
catch (error)
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'landing.site.bindingToMenu',
[
'id' => 31,
'menuCode' => 'crm_switcher:deal',
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . var_export($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error binding site to menu: ' . $e->getMessage();
}
BX24.callMethod(
'landing.site.bindingToMenu',
{
id: 31,
menuCode: 'crm_switcher:deal'
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'landing.site.bindingToMenu',
[
'id' => 31,
'menuCode' => 'crm_switcher:deal',
]
);
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": 1774952664,
"finish": 1774952665.017161,
"duration": 1.0171608924865723,
"processing": 0,
"date_start": "2026-03-31T13:24:24+03:00",
"date_finish": "2026-03-31T13:24:25+03:00",
"operating_reset_at": 1774953265,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Binding result:
|
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "MISSING_PARAMS",
"error_description": "Not enough call parameters, missing: menuCode"
}
|
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 |
Value |
|
|
Not enough call parameters, missing: menuCode |
Method call without |
|
|
Not enough call parameters, missing: id |
Method call without |
|
|
Bitrix\Landing\PublicAction\Site::bindingToMenu(): Argument #1 ($id) must be of type int, string given |
Values provided are incompatible with the method signature |
|
|
Insufficient permissions |
User did not pass general access checks |
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 permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only |
|
|
|
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
- Unbind Knowledge Base from Menu landing.site.unbindingFromMenu
- Get Menu Bindings with landing.site.getMenuBindings
- Bind to Social Network Group landing.site.bindingToGroup
- Get Group Bindings - landing.site.getGroupBindings
- Embedding Knowledge Base: Overview of Methods