Sites

Managing sites on the Bitrix24 platform: create, get, update, delete, search, aggregate. A site is a container of pages of one type: PAGE — landing page, STORE — online store, KNOWLEDGE — Knowledge Base 2.0. Each site has its own domain or subdomain in the Bitrix24 account, a symbolic code, a template, and a set of pages.

Knowledge Base 2.0 is created and managed through the same methods with an additional scope: "KNOWLEDGE" parameter (see create).

Bitrix24 API: landing.site.* Scope: landing

Create site

POST /v1/sites

Creates a new site in your Bitrix24 account. The site type is determined by the type field. Fields are passed flat at the root of the JSON — without the fields wrapper.

Request fields (body)

Examples

curl — personal key

curl -X POST "https://vibecode.bitrix24.com/v1/sites" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Conference landing",
    "code": "conf-2026",
    "type": "PAGE"
  }'

curl — OAuth application

curl -X POST "https://vibecode.bitrix24.com/v1/sites" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Conference landing",
    "code": "conf-2026",
    "type": "PAGE"
  }'

curl — Knowledge Base 2.0 (`scope=KNOWLEDGE`)

curl -X POST "https://vibecode.bitrix24.com/v1/sites" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Company knowledge base",
    "code": "company-knowledge-base",
    "type": "KNOWLEDGE",
    "scope": "KNOWLEDGE"
  }'

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/sites', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Conference landing',
    code: 'conf-2026',
    type: 'PAGE',
  }),
})

const { success, data } = await res.json()
console.log('Site ID:', data.id)

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/sites', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Conference landing',
    code: 'conf-2026',
    type: 'PAGE',
  }),
})

const { success, data } = await res.json()

Response fields

The full object of the created site is returned.

The site URL in Bitrix24 is built from id:

https://<portal>.bitrix24.com/sites/site/<id>/

<portal> is the Bitrix24 portal domain. Access is restricted by the employee's permissions in Bitrix24.

Response example

{
  "success": true,
  "data": {
    "id": 173,
    "title": "Conference landing",
    "code": "/conf-2026/",
    "type": "PAGE",
    "active": false,
    "domainId": 28,
    "createdById": 1,
    "dateCreate": "07.05.2026 12:14:08",
    "dateModify": "07.05.2026 12:14:08"
  }
}

Error response example

422 — invalid site code:

{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "The site address is entered incorrectly. You may use only the following characters: \"a-z\", \"0-9\", \"-\", \".\"."
  }
}

Errors

The full list of common API errors — Errors.

Known specifics

Slashes in the response. The code field in the response is returned with leading and trailing slashes (/conf-2026/) — this is the representation of the site path in the URL. Slashes cannot be passed in the request.

The code key is required. The code value may be an empty string "" or null — then the code is generated from title. But if you omit the code key itself, creation returns 422 BITRIX_ERROR with the message Required field "Site address" is not filled in. If domainId is not provided, the address is generated from code on bitrix24site.com, for example b24-xxxxx.bitrix24site.com.

The active flag cannot be set through the API. The active field is read-only: Bitrix24 does not store the passed value on create or on update, so a request carrying it is refused with 400 READONLY_FIELD before the Bitrix24 call. A new site is always created inactive — active: false in the response; a site is activated by POST /v1/sites/:id/publication or by publishing it in the Bitrix24 account interface.

Home page and error pages. The landingIdIndex, landingId404, landingId503 fields are not set on create — there are no pages yet. Assign them via update after the site pages are created.

Knowledge Base 2.0. Created as a site with type: "KNOWLEDGE" AND scope: "KNOWLEDGE" — both fields are required. Without scope the server returns 403 BITRIX_ACCESS_DENIED, because Bitrix24 creates KNOWLEDGE-type sites only in the knowledge-base section (the same scope is available for list, get, update and delete — see the respective methods). The key's landing scope is sufficient. No separate knowledge-base scope is required.

See also

• List sites
• Update site
• Delete site
• Batch
• Limits and optimization