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

Who 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
type

Description

scope
string

Internal scope of landings. It is not related to the REST scope landing in the method name.
For GROUP, KNOWLEDGE, and MAINPAGE, the value of scope must match the value of fields.TYPE (detailed description)

fields*
object

Set of fields for the new site (detailed description)

Parameter fields

Required parameters are marked with *

Name
type

Description

TITLE*
string

Title of the site, up to 255 characters

CODE*
string

Symbolic code of the site. If an empty string is passed, the code will be generated from the TITLE field. For codes that consist only of digits, a prefix site will be automatically added.

If such a value already exists in the domain, a numeric suffix will be added, for example, code2 or code3

TYPE
string

Type of the site. Default is PAGE. Supported types are PAGE, STORE, SMN, KNOWLEDGE, GROUP, MAINPAGE.

The value must correspond to the scope parameter (detailed description)

DOMAIN_ID
integer | string

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
string

Description of the site, up to 255 characters

XML_ID
string

External identifier, up to 255 characters

ADDITIONAL_FIELDS
object

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

PAGE, STORE, SMN

do not pass

Site or store when the scope parameter is not passed

GROUP

GROUP

Group site

KNOWLEDGE

KNOWLEDGE

Knowledge base

MAINPAGE

MAINPAGE

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
type

Description

result
integer

Identifier of the created site

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

ACCESS_DENIED

Access to create a site is denied: insufficient rights to create a site or an unavailable TYPE for the current scope is passed

SITE_LIMIT_REACHED

Site limit reached: the tariff or license does not allow creating another site

DOMAIN_NOT_FOUND

Domain does not exist

DOMAIN_IS_INCORRECT

The site address is entered incorrectly: an incorrect format of the domain name is passed

DOMAIN_EXIST_TRASH

The domain is already linked to a site in the trash: first unlink the domain from the site in the trash

DOMAIN_DISABLE

The word bitrix cannot be used in the domain: restriction for domains in Bitrix24

DOMAIN_EXIST

Such a domain already exists: the domain is already taken

SLASH_IS_NOT_ALLOWED

Slash is not allowed in the site address: the character / is passed in fields.CODE

CONTROLLER_ERROR_BADRESPONSE

Unrecognized response from the registration service: error from the external domain registration service

CONTROLLER_ERROR_BADLICENSE

License expired or key is incorrect

CONTROLLER_ERROR_<ERROR_CODE>

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