Add site landing.site.add
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:
landingWho can execute the method: a user with "create" access permission for sites
The method landing.site.add creates a new site and returns the identifier of the created site.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
scope |
Internal scope of landings. It is not related to the REST scope |
|
fields* |
Set of fields for the new site (detailed description) |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
TITLE* |
Title of the site, up to |
|
CODE* |
Symbolic code of the site. If an empty string is passed, the code will be generated from the If such a value already exists in the domain, a numeric suffix will be added, for example, |
|
TYPE |
Type of the site. Default is The value must correspond to the |
|
Domain of the site. The value depends on the platform. For Bitrix24, specify the domain name of the site. If the parameter is not filled or an empty string is passed, the domain will be generated automatically based on the system template. For 1C-Bitrix: Site Management, you need to pass the identifier of an already existing domain. Domain name as a string is not supported, the method will return an error |
|
|
DESCRIPTION |
Description of the site, up to |
|
XML_ID |
External identifier, up to |
|
ADDITIONAL_FIELDS |
Additional fields of the site, stored separately after creation |
Correspondence between TYPE and scope
Site types and rules for selecting the scope parameter are described in the article Working with site types and scopes.
|
fields.TYPE |
scope in request |
When to use |
|
|
do not pass |
Site or store when the |
|
|
|
Group site |
|
|
|
Knowledge base |
|
|
|
Main page or vibe |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"scope": "KNOWLEDGE",
"fields": {
"TITLE": "Company Knowledge Base",
"CODE": "",
"TYPE": "KNOWLEDGE",
"DESCRIPTION": "Knowledge base site"
}
}' \
"https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.site.add.json"
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"scope": "KNOWLEDGE",
"fields": {
"TITLE": "Company Knowledge Base",
"CODE": "",
"TYPE": "KNOWLEDGE",
"DESCRIPTION": "Knowledge base site"
},
"auth": "**put_access_token_here**"
}' \
"https://**put.your-domain-here**/rest/landing.site.add.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.site.add',
params: {
scope: 'KNOWLEDGE',
fields: {
TITLE: 'Company knowledge base',
CODE: '',
TYPE: 'KNOWLEDGE',
DESCRIPTION: 'Knowledge base site',
},
},
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('Created site 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 addSite() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'landing.site.add',
params: {
scope: 'KNOWLEDGE',
fields: {
TITLE: 'Company knowledge base',
CODE: '',
TYPE: 'KNOWLEDGE',
DESCRIPTION: 'Knowledge base site',
},
},
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('Created site ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addSite)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.landing.site.add(
scope="KNOWLEDGE",
fields={
"TITLE": "Company knowledge base",
"CODE": "",
"TYPE": "KNOWLEDGE",
"DESCRIPTION": "Knowledge base site",
},
).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.site.add',
[
'scope' => 'KNOWLEDGE',
'fields' => [
'TITLE' => 'Company Knowledge Base',
'CODE' => '',
'TYPE' => 'KNOWLEDGE',
'DESCRIPTION' => 'Knowledge base site',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding site: ' . $e->getMessage();
}
BX24.callMethod(
'landing.site.add',
{
scope: 'KNOWLEDGE',
fields: {
TITLE: 'Company Knowledge Base',
CODE: '',
TYPE: 'KNOWLEDGE',
DESCRIPTION: 'Knowledge base site'
}
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'landing.site.add',
[
'scope' => 'KNOWLEDGE',
'fields' => [
'TITLE' => 'Company Knowledge Base',
'CODE' => '',
'TYPE' => 'KNOWLEDGE',
'DESCRIPTION' => 'Knowledge base site',
],
]
);
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.site.add", b24.Params{
"scope": "KNOWLEDGE",
"fields": b24.Params{
"TITLE": "Company Knowledge Base",
"CODE": "",
"TYPE": "KNOWLEDGE",
"DESCRIPTION": "Knowledge base site",
},
})
if err != nil {
return fmt.Errorf("landing.site.add: %w", err)
}
var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("id:", newID)
Response Handling
HTTP status: 200
{
"result": 159,
"time": {
"start": 1773161828,
"finish": 1773161828.444154,
"duration": 0.4441540241241455,
"processing": 0,
"date_start": "2026-03-10T19:57:08+01:00",
"date_finish": "2026-03-10T19:57:08+01:00",
"operating_reset_at": 1773162428,
"operating": 0.14034819602966309
}
}
Returned Data
|
Name |
Description |
|
result |
Identifier of the created site |
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 400
{
"error": "DOMAIN_IS_INCORRECT",
"error_description": "The site address is entered incorrectly. You can only use the following characters: \"a-z\", \"0-9\", \"-\", \".\"."
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
Access to create a site is denied: insufficient rights to create a site or an unavailable |
|
|
Site limit reached: the tariff or license does not allow creating another site |
|
|
Domain does not exist |
|
|
The site address is entered incorrectly: an incorrect format of the domain name is passed |
|
|
The domain is already linked to a site in the trash: first unlink the domain from the site in the trash |
|
|
The word bitrix cannot be used in the domain: restriction for domains in Bitrix24 |
|
|
Such a domain already exists: the domain is already taken |
|
|
Slash is not allowed in the site address: the character |
|
|
Unrecognized response from the registration service: error from the external domain registration service |
|
|
License expired or key is incorrect |
|
|
Error from the external domain registration service: the error code depends on the response from the domain registration controller |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |