Add Site landing.site.add

Scope: landing

Who can execute the method: 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 for 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 consisting only of digits, the 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 according to the system template. For 1C-Bitrix: Site Management, you need to provide 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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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"

try
        {
        	const response = await $b24.callMethod(
        		'landing.site.add',
        		{
                    scope: 'KNOWLEDGE',
        			fields: {
        				TITLE: 'Company Knowledge Base',
        				CODE: '',
        				TYPE: 'KNOWLEDGE',
        				DESCRIPTION: 'Knowledge base site'
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.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>';
        }

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 incorrect. You can only use the following characters: \"a-z\", \"0-9\", \"-\", \".\"."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `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
`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 plan or license does not allow creating another site
`DOMAIN_NOT_FOUND`	Domain does not exist
`DOMAIN_IS_INCORRECT`	The site address is incorrect: an invalid domain name format 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: error code depends on the response from the domain registration controller

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Additional Fields

Add Folder

Add Site landing.site.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Correspondence between TYPE and scopeCorrespondence between TYPE and scope

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning