openapi: 3.0.3
info:
title: Bitrix24 REST BIconnector Sites API
version: 1.0.0
description: 'Bitrix24 REST API provides access to CRM, tasks, drive, chats, telephony, e-commerce, automation, and other modules. Documentation: https://apidocs.bitrix24.com'
contact:
name: Bitrix24 Developer Support
url: https://apidocs.bitrix24.com/support.html
license:
name: MIT
url: https://github.com/bitrix-tools/b24-rest-docs/blob/main/LICENSE
x-logo:
url: https://apidocs.bitrix24.com/_images/bitrix24logo.svg
servers:
- url: https://{portal}.bitrix24.com/rest
description: Your Bitrix24 portal (cloud)
variables:
portal:
default: your-portal
description: Subdomain of your Bitrix24 portal
- url: https://{host}/rest
description: On-Premise Bitrix24 installation
variables:
host:
default: your-bitrix24.example.com
description: Host of your on-premise installation
security:
- AccessToken: []
tags:
- name: Sites
paths:
/landing.block.addcard:
post:
summary: Add Card to Block landing.block.addcard
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.addcard` adds a card to a block in the draft of a page. This method works with cards described in the `cards` key of the block manifest. If the page is already published, changes will be visible to visitors after re-publishing through the interface or using the [landing.landing.publication](../../page/methods/landing-landing-publication.md) method.
operationId: landing_block_addcard
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-add-card.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the editable version of the page.'
selector:
type: string
description: '| Selector of the card from the key `cards` of the block manifest'
content:
type: string
description: '| HTML of the new card.'
preventHistory:
type: boolean
description: '| Do not add the action to the page change history.'
required:
- lid
- block
- selector
- content
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the editable version of the page.'
selector:
type: string
description: '| Selector of the card from the key `cards` of the block manifest'
content:
type: string
description: '| HTML of the new card.'
preventHistory:
type: boolean
description: '| Do not add the action to the page change history.'
required:
- lid
- block
- selector
- content
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.block.changeAnchor:
post:
summary: Change the Anchor of the Block landing.block.changeAnchor
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.changeAnchor` modifies or removes a custom anchor of a block in the draft of a page. If the page is already published, changes will be visible to visitors after publishing the updates through the interface or using the method [landing.landing.publication](../../page/methods/landing-landing-publication.md).
operationId: landing_block_changeAnchor
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-change-anchor.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the draft of the page.'
data:
type: string
description: '| New anchor of the block without the `#` symbol.'
preventHistory:
type: boolean
description: '| Do not add the change to the page history.'
required:
- lid
- block
- data
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the draft of the page.'
data:
type: string
description: '| New anchor of the block without the `#` symbol.'
preventHistory:
type: boolean
description: '| Do not add the change to the page history.'
required:
- lid
- block
- data
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.block.changeNodeName:
post:
summary: Change HTML Tag of a Block Element landing.block.changeNodeName
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.changeNodeName` changes the HTML tag of a block element in the draft of a page. If the page is already published, changes will be visible to visitors after re-publishing through the interface or using the method [landing.landing.publication](../../page/methods/landing-landing-publication.md).
operationId: landing_block_changeNodeName
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-change-node-name.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page'
block:
type: integer
description: '| Identifier of the block in the draft of the page'
data:
type: object
description: '| Set of changes for block elements (detailed description) ||'
preventHistory:
type: boolean
description: '| If `true` is passed, the method will not add the action to the page change history'
Value:
type: string
description: '| Description ||'
required:
- lid
- block
- data
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page'
block:
type: integer
description: '| Identifier of the block in the draft of the page'
data:
type: object
description: '| Set of changes for block elements (detailed description) ||'
preventHistory:
type: boolean
description: '| If `true` is passed, the method will not add the action to the page change history'
Value:
type: string
description: '| Description ||'
required:
- lid
- block
- data
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.block.clonecard:
post:
summary: Clone Card of Block landing.block.clonecard
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.clonecard` creates a copy of a card in the block within the draft of the page. It works with cards described in the `cards` key of the block manifest. If the page is already published, the changes will be visible to visitors after publication through the interface or by using the [landing.landing.publication](../../page/methods/landing-landing-publication.md) method.
operationId: landing_block_clonecard
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-clone-card.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the draft of the page.'
selector:
type: string
description: '| Selector of the card from the cards key of the block manifest.'
preventHistory:
type: boolean
description: '| Do not add the action to the page change history.'
required:
- lid
- block
- selector
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the draft of the page.'
selector:
type: string
description: '| Selector of the card from the cards key of the block manifest.'
preventHistory:
type: boolean
description: '| Do not add the action to the page change history.'
required:
- lid
- block
- selector
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.block.getContentFromRepository:
post:
summary: Get Block Content from Repository landing.block.getContentFromRepository
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.getContentFromRepository` returns the HTML content of a block from the repository.
operationId: landing_block_getContentFromRepository
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-content-from-repository.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: '| The code of the block whose content needs to be retrieved.'
required:
- code
application/x-www-form-urlencoded:
schema:
type: object
properties:
code:
type: string
description: '| The code of the block whose content needs to be retrieved.'
required:
- code
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.block.getbyid:
post:
summary: Get Block by ID landing.block.getbyid
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.getbyid` returns a single block of a page by its identifier.
operationId: landing_block_getbyid
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-by-id.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
block:
type: integer
description: '| Block identifier.'
params:
type: object
description: '| Additional parameters for reading the block (detailed description) ||'
edit_mode:
type: boolean
description: \| `integer` | If set to `true`, the method reads the draft version of the page instead of the published version.
deleted:
type: boolean
description: \| `integer` | If set to `true`, the method searches for blocks marked as deleted.
get_content:
type: boolean
description: \| `integer` | If set to `true`, the `result` additionally returns the fields `content`, `css`, and `js`.
required:
- block
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
block:
type: integer
description: '| Block identifier.'
params:
type: object
description: '| Additional parameters for reading the block (detailed description) ||'
edit_mode:
type: boolean
description: \| `integer` | If set to `true`, the method reads the draft version of the page instead of the published version.
deleted:
type: boolean
description: \| `integer` | If set to `true`, the method searches for blocks marked as deleted.
get_content:
type: boolean
description: \| `integer` | If set to `true`, the `result` additionally returns the fields `content`, `css`, and `js`.
required:
- block
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.block.getcontent:
post:
summary: Get Content of Block landing.block.getcontent
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.getcontent` returns the ready HTML of the block, its resources, manifest, and service properties of the block.
operationId: landing_block_getcontent
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-content.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Page identifier.'
block:
type: integer
description: '| Block identifier.'
editMode:
type: boolean
description: '| Mode for obtaining the version of the block.'
params:
type: object
description: '| Additional parameters (detailed description) ||'
wrapper_show:
type: boolean
description: '| Whether to return the external container of the block `
` in `result.content`.'
force_unactive:
type: boolean
description: '| Generate HTML even for inactive blocks.'
required:
- lid
- block
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Page identifier.'
block:
type: integer
description: '| Block identifier.'
editMode:
type: boolean
description: '| Mode for obtaining the version of the block.'
params:
type: object
description: '| Additional parameters (detailed description) ||'
wrapper_show:
type: boolean
description: '| Whether to return the external container of the block `
` in `result.content`.'
force_unactive:
type: boolean
description: '| Generate HTML even for inactive blocks.'
required:
- lid
- block
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.block.getlist:
post:
summary: Get the List of Page Blocks landing.block.getlist
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.getlist` returns a list of blocks for the selected page.
operationId: landing_block_getlist
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-list.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope for landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: \| [`integer[]`](../../../data-types.md) | Identifier of the page or an array of page identifiers.
params:
type: object
description: '| Additional parameters for reading the list (detailed description) ||'
edit_mode:
type: boolean
description: \| `integer` | If the value is cast to `true`, the method reads the draft version of the page instead of the published version.
deleted:
type: boolean
description: \| `integer` | If the value is cast to `true`, the method returns only blocks marked as deleted.
get_content:
type: boolean
description: \| `integer` | If `true` is passed, the method will add the `content`, `css`, and `js` fields to each result element. By default — `false`.
required:
- lid
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope for landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: \| [`integer[]`](../../../data-types.md) | Identifier of the page or an array of page identifiers.
params:
type: object
description: '| Additional parameters for reading the list (detailed description) ||'
edit_mode:
type: boolean
description: \| `integer` | If the value is cast to `true`, the method reads the draft version of the page instead of the published version.
deleted:
type: boolean
description: \| `integer` | If the value is cast to `true`, the method returns only blocks marked as deleted.
get_content:
type: boolean
description: \| `integer` | If `true` is passed, the method will add the `content`, `css`, and `js` fields to each result element. By default — `false`.
required:
- lid
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.block.getmanifest:
post:
summary: Get the Manifest of the landing.block.getmanifest Method
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `landing.block.getmanifest` method returns a prepared manifest of the block placed on the page. It does not return the original file but rather the prepared data for a specific block. For example, localized titles, fields such as `code`, `preview`, `assets`, `timestamp`, and `callbacks`.
operationId: landing_block_getmanifest
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-manifest.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Page identifier.'
block:
type: integer
description: '| Block identifier. The block must belong to the page `lid` in the selected version of the page.'
params:
type: object
description: '| Additional parameters for reading the manifest (detailed description) ||'
edit_mode:
type: boolean
description: \| `integer` | If the value is cast to `true`, the method reads the draft of the page instead of the published version. Default is `false`.
required:
- lid
- block
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Page identifier.'
block:
type: integer
description: '| Block identifier. The block must belong to the page `lid` in the selected version of the page.'
params:
type: object
description: '| Additional parameters for reading the manifest (detailed description) ||'
edit_mode:
type: boolean
description: \| `integer` | If the value is cast to `true`, the method reads the draft of the page instead of the published version. Default is `false`.
required:
- lid
- block
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.block.getmanifestfile:
post:
summary: Get the Manifest File of the Block landing.block.getmanifestfile
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.getmanifestfile` returns the original manifest of the block from the file repository. Unlike [landing.block.getmanifest](./landing-block-get-manifest.md), this method returns the manifest in its original form — as specified in the `.description.php` file. It does not add any service fields, such as `code`, `preview`, or `timestamp`.
operationId: landing_block_getmanifestfile
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-manifest-file.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: '| The code of the block from the file repository.'
required:
- code
application/x-www-form-urlencoded:
schema:
type: object
properties:
code:
type: string
description: '| The code of the block from the file repository.'
required:
- code
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.block.getrepository:
post:
summary: Get a List of Blocks from the Repository landing.block.getrepository
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.getrepository` returns the available sections of the block repository or the data for a specific section.
operationId: landing_block_getrepository
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-get-repository.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
section:
type: string
description: '| The code of the repository section, for example `text`.'
scope:
type: string
description: '| An additional top-level parameter of the REST call that affects the type of site for which the repository is being collected.'
application/x-www-form-urlencoded:
schema:
type: object
properties:
section:
type: string
description: '| The code of the repository section, for example `text`.'
scope:
type: string
description: '| An additional top-level parameter of the REST call that affects the type of site for which the repository is being collected.'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.block.removecard:
post:
summary: Remove Card from Block landing.block.removecard
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.removecard` removes a card from a block in the draft of a page. This method only works with cards described in the `cards` key of the block manifest. If the page is already published, the change will be visible to visitors after publication through the interface or by using the [landing.landing.publication](../../page/methods/landing-landing-publication.md) method.
operationId: landing_block_removecard
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-remove-card.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the editable version of the page.'
selector:
type: string
description: '| Selector of the card from the cards section of the block manifest'
preventHistory:
type: boolean
description: '| Do not add the action to the page change history.'
required:
- lid
- block
- selector
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the editable version of the page.'
selector:
type: string
description: '| Selector of the card from the cards section of the block manifest'
preventHistory:
type: boolean
description: '| Do not add the action to the page change history.'
required:
- lid
- block
- selector
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.block.updateCards:
post:
summary: Update Cards in landing.block.updateCards
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.updateCards` updates a set of cards in a block and the nodes within those cards in the draft of the page. This method works with cards described in the `cards` key of the block manifest. If the page is already published, changes will be visible to visitors after publication through the interface or by using the [landing.landing.publication](../../page/methods/landing-landing-publication.md) method.
operationId: landing_block_updateCards
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-cards.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the draft of the page.'
data:
type: object
description: '| Set of changes for the block cards (detailed description) ||'
source:
type: array
items: {}
description: '| Defines the final order and number of cards (detailed description) ||'
values:
type: array
items: {}
description: '| Updates nodes within cards after applying `source` (detailed description) ||'
type:
type: string
description: '| Type of the card source.'
value:
type: integer
description: \| `string` | Value of the card source.
required:
- lid
- block
- data
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the draft of the page.'
data:
type: object
description: '| Set of changes for the block cards (detailed description) ||'
source:
type: array
items: {}
description: '| Defines the final order and number of cards (detailed description) ||'
values:
type: array
items: {}
description: '| Updates nodes within cards after applying `source` (detailed description) ||'
type:
type: string
description: '| Type of the card source.'
value:
type: integer
description: \| `string` | Value of the card source.
required:
- lid
- block
- data
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.block.updateStyles:
post:
summary: Update Styles for landing.block.updateStyles
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.updateStyles` updates the CSS classes and inline styles of block elements in the draft of a page. If the page is already published, changes will be visible to visitors after re-publishing through the interface or using the [landing.landing.publication](../../page/methods/landing-landing-publication.md) method.
operationId: landing_block_updateStyles
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-styles.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the version of the page for editing.'
data:
type: object
description: '| Object format:'
preventHistory:
type: boolean
description: '| If `true` is passed, the method will not add the change to the page history.'
classList:
type: array
items: {}
description: '| List of CSS classes for the element after the update.'
affect:
type: array
items: {}
description: '| List of CSS properties to be removed from the inline styles of all nested elements of the found node. For example, `["text-align", "color"]` ||'
style:
type: object
description: '| Set of inline styles for the found element in the format `{ "css-property": "value" }`. The method merges the passed values with the current `style` attribute.'
required:
- lid
- block
- data
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the version of the page for editing.'
data:
type: object
description: '| Object format:'
preventHistory:
type: boolean
description: '| If `true` is passed, the method will not add the change to the page history.'
classList:
type: array
items: {}
description: '| List of CSS classes for the element after the update.'
affect:
type: array
items: {}
description: '| List of CSS properties to be removed from the inline styles of all nested elements of the found node. For example, `["text-align", "color"]` ||'
style:
type: object
description: '| Set of inline styles for the found element in the format `{ "css-property": "value" }`. The method merges the passed values with the current `style` attribute.'
required:
- lid
- block
- data
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.block.updateattrs:
post:
summary: Change Attributes of Block Elements landing.block.updateattrs
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.updateattrs` updates the attributes of HTML elements within a block in the draft of a page. This method does not change the text, the entire HTML code of the block, or styles. It only updates the attribute values of already existing elements, such as `href`, `target`, `alt`, `title`, `data-*`, and `aria-*`. If the page is already published, changes will be visible to visitors after re-publishing through the interface or using the [landing.landing.publication](../../page/methods/landing-landing-publication.md) method.
operationId: landing_block_updateattrs
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-attrs.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the version of the page for editing.'
data:
type: object
description: '| Set of attributes to update (detailed description) ||'
required:
- lid
- block
- data
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the version of the page for editing.'
data:
type: object
description: '| Set of attributes to update (detailed description) ||'
required:
- lid
- block
- data
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.block.updatecontent:
post:
summary: Update Content of the Block landing.block.updatecontent
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.updatecontent` completely replaces the HTML content of a block in the page draft. If you only need to change specific nodes, attributes, or styles of the block, use the methods [landing.block.updatenodes](./landing-block-update-nodes.md), [landing.block.updateattrs](./landing-block-update-attrs.md), and [landing.block.updateStyles](./landing-block-update-styles.md).
operationId: landing_block_updatecontent
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-content.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the page draft.'
content:
type: string
description: '| New HTML content of the block.'
designed:
type: boolean
description: \| `integer` \| `string` | Marks the block as manually modified.
preventHistory:
type: boolean
description: '| Do not add the change to the page history. Default is `false` ||'
required:
- lid
- block
- content
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the page draft.'
content:
type: string
description: '| New HTML content of the block.'
designed:
type: boolean
description: \| `integer` \| `string` | Marks the block as manually modified.
preventHistory:
type: boolean
description: '| Do not add the change to the page history. Default is `false` ||'
required:
- lid
- block
- content
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.block.updatenodes:
post:
summary: Update Nodes of the Block landing.block.updatenodes
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.updatenodes` updates the nodes of a block in the draft of a page. If the page is already published, changes will be visible to visitors after re-publishing through the interface or using the method [landing.landing.publication](../../page/methods/landing-landing-publication.md).
operationId: landing_block_updatenodes
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-update-nodes.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the version of the page for editing.'
data:
type: object
description: '| Set of changes for the block nodes and component parameters available for editing (detailed description) ||'
additional:
type: object
description: '| Additional save parameters (detailed description) ||'
preventHistory:
type: boolean
description: '| If set to `true`, the method will not add the action to the page change history. Default is `false` ||'
appendMenu:
type: boolean
description: '| Adds new items to the current menu instead of completely replacing it. Works only for blocks that have a `menu` section described in the manifest.'
required:
- lid
- block
- data
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the version of the page for editing.'
data:
type: object
description: '| Set of changes for the block nodes and component parameters available for editing (detailed description) ||'
additional:
type: object
description: '| Additional save parameters (detailed description) ||'
preventHistory:
type: boolean
description: '| If set to `true`, the method will not add the action to the page change history. Default is `false` ||'
appendMenu:
type: boolean
description: '| Adds new items to the current menu instead of completely replacing it. Works only for blocks that have a `menu` section described in the manifest.'
required:
- lid
- block
- data
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.block.uploadfile:
post:
summary: Upload and Attach an Image to the Block landing.block.uploadfile
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.block.uploadfile` uploads an image and attaches it to the specified block. In response, the method returns the file identifier and a link to it in the `src` field. The method does not insert the image into the block itself. This means that after uploading, the file exists, but it is not yet displayed in the block's content. Typically, after `landing.block.uploadfile`, the [landing.block.updatenodes](./landing-block-update-nodes.md) method is called.
operationId: landing_block_uploadfile
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/block/methods/landing-block-upload-file.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
block:
type: integer
description: '| Identifier of the block to which the image needs to be attached.'
picture:
type: string
description: \| [`string[]`](../../../data-types.md) | Image to upload.
ext:
type: string
description: '| File extension for uploading via URL, if it cannot be accurately determined from the address.'
params:
type: object
description: '| Additional parameters for image processing (detailed description).'
temp:
type: boolean
description: \| `integer` | If the value is cast to `true`, the file is marked as temporary.
width:
type: integer
description: '| Target width of the image in pixels.'
height:
type: integer
description: '| Target height of the image in pixels.'
resize_type:
type: integer
description: '| Resizing mode.'
required:
- block
- picture
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
block:
type: integer
description: '| Identifier of the block to which the image needs to be attached.'
picture:
type: string
description: \| [`string[]`](../../../data-types.md) | Image to upload.
ext:
type: string
description: '| File extension for uploading via URL, if it cannot be accurately determined from the address.'
params:
type: object
description: '| Additional parameters for image processing (detailed description).'
temp:
type: boolean
description: \| `integer` | If the value is cast to `true`, the file is marked as temporary.
width:
type: integer
description: '| Target width of the image in pixels.'
height:
type: integer
description: '| Target height of the image in pixels.'
resize_type:
type: integer
description: '| Resizing mode.'
required:
- block
- picture
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.demos.getList:
post:
summary: Get a List of Registered Templates landing.demos.getList
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.demos.getList` retrieves a list of registered templates.
operationId: landing_demos_getList
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/demos/landing-demos-get-list.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
params:
type: object
description: '| Object format:'
select:
type: string
description: '| Array format:'
filter:
type: object
description: '| Object format:'
order:
type: object
description: '| Object format:'
group:
type: array
items: {}
description: '| Array of fields for grouping the result.'
limit:
type: integer
description: '| Limit on the number of records in the selection ||'
offset:
type: integer
description: '| Offset of records in the selection ||'
application/x-www-form-urlencoded:
schema:
type: object
properties:
params:
type: object
description: '| Object format:'
select:
type: string
description: '| Array format:'
filter:
type: object
description: '| Object format:'
order:
type: object
description: '| Object format:'
group:
type: array
items: {}
description: '| Array of fields for grouping the result.'
limit:
type: integer
description: '| Limit on the number of records in the selection ||'
offset:
type: integer
description: '| Offset of records in the selection ||'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.demos.getPageList:
post:
summary: Get a List of Templates for Creating Pages landing.demos.getPageList
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.demos.getPageList` retrieves a list of file demo templates for pages.
operationId: landing_demos_getPageList
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/demos/landing-demos-get-page-list.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
filter:
type: object
description: '| Object format:'
application/x-www-form-urlencoded:
schema:
type: object
properties:
filter:
type: object
description: '| Object format:'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.demos.getSiteList:
post:
summary: Get a List of Templates for Creating Websites landing.demos.getSiteList
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.demos.getSiteList` retrieves a list of file demo templates for websites.
operationId: landing_demos_getSiteList
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/demos/landing-demos-get-site-list.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
filter:
type: object
description: '| Object format:'
application/x-www-form-urlencoded:
schema:
type: object
properties:
filter:
type: object
description: '| Object format:'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.demos.register:
post:
summary: Register a Template in the Site Creation Wizard landing.demos.register
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.demos.register` registers a custom template in the site and page creation wizard. The method updates the template if it already exists with the same code for the current application. If it does not exist, it creates a new one.
operationId: landing_demos_register
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/demos/landing-demos-register.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
params:
type: object
description: '| Additional registration parameters more details ||'
charset:
type: string
description: '| Encoding of the exported template ||'
site_code:
type: string
description: '| Site code (path) ||'
name:
type: string
description: '| Template name ||'
description:
type: string
description: \| `null` | Template description ||
type:
type: string
description: '| Template type.'
tpl_type:
type: string
description: '| Template usage type in the wizard.'
fields:
type: object
description: '| Site fields from the export more details ||'
folders:
type: array
items: {}
description: \| `object` | Folders from the export more details ||
items:
type: object
description: '| Map of template pages in the format `{ "page_code": items }` more details ||'
layout:
type: array
items: {}
description: \| `object` | Layout data from the export more details ||
preview:
type: string
description: '| Link to preview 1x ||'
preview2x:
type: string
description: '| Link to preview 2x ||'
preview3x:
type: string
description: '| Link to preview 3x ||'
preview_url:
type: string
description: '| Link to preview ||'
show_in_list:
type: string
description: '| Indicator for display in the list (`Y`/`N`) ||'
syspages:
type: array
items: {}
description: \| `object` | System pages from the export more details ||
version:
type: integer
description: '| Version of the export format ||'
old_id:
type: string
description: \| `integer` | Original page identifier ||
code:
type: string
description: '| Block code ||'
access:
type: string
description: '| Access level to the block ||'
anchor:
type: string
description: '| Block anchor ||'
cards:
type: object
description: '| Block cards ||'
nodes:
type: object
description: '| Block nodes ||'
style:
type: object
description: '| Block styles ||'
attrs:
type: object
description: '| Block attributes ||'
site_template_id:
type: string
description: '| Identifier of the site template of the main module.'
lang:
type: object
description: '| Localization of the main phrases of the template.'
lang_original:
type: string
description: '| Code of the original language for the `lang` array ||'
application/x-www-form-urlencoded:
schema:
type: object
properties:
params:
type: object
description: '| Additional registration parameters more details ||'
charset:
type: string
description: '| Encoding of the exported template ||'
site_code:
type: string
description: '| Site code (path) ||'
name:
type: string
description: '| Template name ||'
description:
type: string
description: \| `null` | Template description ||
type:
type: string
description: '| Template type.'
tpl_type:
type: string
description: '| Template usage type in the wizard.'
fields:
type: object
description: '| Site fields from the export more details ||'
folders:
type: array
items: {}
description: \| `object` | Folders from the export more details ||
items:
type: object
description: '| Map of template pages in the format `{ "page_code": items }` more details ||'
layout:
type: array
items: {}
description: \| `object` | Layout data from the export more details ||
preview:
type: string
description: '| Link to preview 1x ||'
preview2x:
type: string
description: '| Link to preview 2x ||'
preview3x:
type: string
description: '| Link to preview 3x ||'
preview_url:
type: string
description: '| Link to preview ||'
show_in_list:
type: string
description: '| Indicator for display in the list (`Y`/`N`) ||'
syspages:
type: array
items: {}
description: \| `object` | System pages from the export more details ||
version:
type: integer
description: '| Version of the export format ||'
old_id:
type: string
description: \| `integer` | Original page identifier ||
code:
type: string
description: '| Block code ||'
access:
type: string
description: '| Access level to the block ||'
anchor:
type: string
description: '| Block anchor ||'
cards:
type: object
description: '| Block cards ||'
nodes:
type: object
description: '| Block nodes ||'
style:
type: object
description: '| Block styles ||'
attrs:
type: object
description: '| Block attributes ||'
site_template_id:
type: string
description: '| Identifier of the site template of the main module.'
lang:
type: object
description: '| Localization of the main phrases of the template.'
lang_original:
type: string
description: '| Code of the original language for the `lang` array ||'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.demos.unregister:
post:
summary: Delete Registered Template landing.demos.unregister
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.demos.unregister` deletes a registered template by its code.
operationId: landing_demos_unregister
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/demos/landing-demos-unregister.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
application/x-www-form-urlencoded:
schema:
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.add:
post:
summary: Add Page or Folder landing.landing.add
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.add` adds a page or folder to the specified site and returns the identifier of the created object. The new object is created as inactive (`ACTIVE = N`).
operationId: landing_landing_add
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-add.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
fields:
type: object
description: '| Set of fields for the new page or folder (detailed description) ||'
TITLE:
type: string
description: '| Title of the page ||'
SITE_ID:
type: integer
description: '| Identifier of the site where the page is created.'
CODE:
type: string
description: '| Symbolic code of the page. It must not contain the character `/` and must not be in the format `__`, for example `code_12_34`.'
DESCRIPTION:
type: string
description: '| Arbitrary description of the page ||'
XML_ID:
type: string
description: '| External identifier of the page ||'
SITEMAP:
type: string
description: '| Flag to include the page in the sitemap. Supported values are `Y` and `N`, default is `N` ||'
FOLDER:
type: string
description: '| Used if a folder needs to be created instead of a page. Supported values are `Y` and `N`, default is `N` ||'
FOLDER_ID:
type: integer
description: '| Identifier of the folder where the page should be created. The folder must belong to the same site as `SITE_ID`.'
TPL_ID:
type: integer
description: '| Identifier of the page view template.'
ADDITIONAL_FIELDS:
type: object
description: '| Additional fields of the page. Available codes and values are described in the article Additional Page Fields ||'
BLOCK_ID:
type: integer
description: '| Used together with `MENU_CODE` to add a link to the menu of the block with the specified identifier after the page is created ||'
MENU_CODE:
type: string
description: '| Used together with `BLOCK_ID` to specify the menu code in the block where the link to the created page should be added ||'
required:
- fields
- TITLE
- SITE_ID
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
fields:
type: object
description: '| Set of fields for the new page or folder (detailed description) ||'
TITLE:
type: string
description: '| Title of the page ||'
SITE_ID:
type: integer
description: '| Identifier of the site where the page is created.'
CODE:
type: string
description: '| Symbolic code of the page. It must not contain the character `/` and must not be in the format `__`, for example `code_12_34`.'
DESCRIPTION:
type: string
description: '| Arbitrary description of the page ||'
XML_ID:
type: string
description: '| External identifier of the page ||'
SITEMAP:
type: string
description: '| Flag to include the page in the sitemap. Supported values are `Y` and `N`, default is `N` ||'
FOLDER:
type: string
description: '| Used if a folder needs to be created instead of a page. Supported values are `Y` and `N`, default is `N` ||'
FOLDER_ID:
type: integer
description: '| Identifier of the folder where the page should be created. The folder must belong to the same site as `SITE_ID`.'
TPL_ID:
type: integer
description: '| Identifier of the page view template.'
ADDITIONAL_FIELDS:
type: object
description: '| Additional fields of the page. Available codes and values are described in the article Additional Page Fields ||'
BLOCK_ID:
type: integer
description: '| Used together with `MENU_CODE` to add a link to the menu of the block with the specified identifier after the page is created ||'
MENU_CODE:
type: string
description: '| Used together with `BLOCK_ID` to specify the menu code in the block where the link to the created page should be added ||'
required:
- fields
- TITLE
- SITE_ID
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.addByTemplate:
post:
summary: Add Page by Template landing.landing.addByTemplate
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.addByTemplate` creates a page in the specified site based on the template code and returns the identifier of the created page. The new page is created as inactive (`ACTIVE = N`). If you need to fully manage the fields of the created page, use [landing.landing.add](./landing-landing-add.md).
operationId: landing_landing_addByTemplate
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-add-by-template.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
siteId:
type: integer
description: '| Identifier of the site where the page needs to be created.'
code:
type: string
description: '| Template code for the page.'
fields:
type: object
description: '| Additional parameters for creating the page (detailed description) ||'
TITLE:
type: string
description: '| Overrides the title of the created page and the SEO titles of the template.'
DESCRIPTION:
type: string
description: '| Overrides the SEO descriptions of the template.'
ID:
type: integer
description: '| Identifier of an existing page or folder in the same site.'
FOLDER_ID:
type: integer
description: '| Identifier of the folder where the page needs to be created. The folder must belong to the same site as `siteId`, otherwise the method will return an error.'
SITE_TYPE:
type: string
description: '| Type of templates from which the page is created. Site types from the article Working with Site Types and Scopes are used.'
PREPARE_BLOCKS:
type: boolean
description: '| Enables preparation of template blocks when creating the page.'
PREPARE_BLOCKS_DATA:
type: object
description: '| Additional data for preparing template blocks when creating the page.'
ADD_IN_MENU:
type: string
description: '| Flag for adding the created page to the site menu. Supported values are `Y` and `N`.'
BLOCK_ID:
type: integer
description: '| Together with `MENU_CODE`, adds a link to the created page in the menu of the block with the specified identifier ||'
MENU_CODE:
type: string
description: '| Together with `BLOCK_ID`, specifies the menu code within the block where the link to the created page should be added ||'
ACTION:
type: string
description: '| What needs to be done with the block. The value `changeComponentParams` is supported ||'
PARAMS:
type: object
description: '| Component parameters that need to be substituted into the block when creating the page.'
Parameter:
type: string
description: '| Description ||'
required:
- siteId
- code
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
siteId:
type: integer
description: '| Identifier of the site where the page needs to be created.'
code:
type: string
description: '| Template code for the page.'
fields:
type: object
description: '| Additional parameters for creating the page (detailed description) ||'
TITLE:
type: string
description: '| Overrides the title of the created page and the SEO titles of the template.'
DESCRIPTION:
type: string
description: '| Overrides the SEO descriptions of the template.'
ID:
type: integer
description: '| Identifier of an existing page or folder in the same site.'
FOLDER_ID:
type: integer
description: '| Identifier of the folder where the page needs to be created. The folder must belong to the same site as `siteId`, otherwise the method will return an error.'
SITE_TYPE:
type: string
description: '| Type of templates from which the page is created. Site types from the article Working with Site Types and Scopes are used.'
PREPARE_BLOCKS:
type: boolean
description: '| Enables preparation of template blocks when creating the page.'
PREPARE_BLOCKS_DATA:
type: object
description: '| Additional data for preparing template blocks when creating the page.'
ADD_IN_MENU:
type: string
description: '| Flag for adding the created page to the site menu. Supported values are `Y` and `N`.'
BLOCK_ID:
type: integer
description: '| Together with `MENU_CODE`, adds a link to the created page in the menu of the block with the specified identifier ||'
MENU_CODE:
type: string
description: '| Together with `BLOCK_ID`, specifies the menu code within the block where the link to the created page should be added ||'
ACTION:
type: string
description: '| What needs to be done with the block. The value `changeComponentParams` is supported ||'
PARAMS:
type: object
description: '| Component parameters that need to be substituted into the block when creating the page.'
Parameter:
type: string
description: '| Description ||'
required:
- siteId
- code
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.addblock:
post:
summary: Add Block to Page landing.landing.addblock
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.addblock` adds a new block to the page and returns the identifier of the created block. If the page is already published, the new block will be visible to visitors after the "Publish Changes" command in the interface or after calling the method [landing.landing.publication](../methods/landing-landing-publication.md).
operationId: landing_landing_addblock
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-add-block.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Page identifier.'
fields:
type: object
description: '| Set of parameters for the new block (detailed description) ||'
preventHistory:
type: boolean
description: '| If `true`, the method does not add the action to the page change history. Default is `false` ||'
CODE:
type: string
description: '| Symbolic code of the block from the repository.'
AFTER_ID:
type: integer
description: '| Identifier of the block after which the new block should be inserted.'
ACTIVE:
type: string
description: '| Flag indicating the activity of the new block. Possible values:'
CONTENT:
type: string
description: '| HTML content of the block. Allows replacing the standard content of the block with your own HTML code. The block code must still be available in the repository for the current type of page and `scope`. Before saving, the value is cleaned and validated ||'
RETURN_CONTENT:
type: string
description: '| If `Y` is passed, after adding the block, the method will return not only its identifier but also the block data (detailed description). For any other value, the method will return only the block identifier ||'
required:
- lid
- fields
- CODE
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Page identifier.'
fields:
type: object
description: '| Set of parameters for the new block (detailed description) ||'
preventHistory:
type: boolean
description: '| If `true`, the method does not add the action to the page change history. Default is `false` ||'
CODE:
type: string
description: '| Symbolic code of the block from the repository.'
AFTER_ID:
type: integer
description: '| Identifier of the block after which the new block should be inserted.'
ACTIVE:
type: string
description: '| Flag indicating the activity of the new block. Possible values:'
CONTENT:
type: string
description: '| HTML content of the block. Allows replacing the standard content of the block with your own HTML code. The block code must still be available in the repository for the current type of page and `scope`. Before saving, the value is cleaned and validated ||'
RETURN_CONTENT:
type: string
description: '| If `Y` is passed, after adding the block, the method will return not only its identifier but also the block data (detailed description). For any other value, the method will return only the block identifier ||'
required:
- lid
- fields
- CODE
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.copy:
post:
summary: Copy Page landing.landing.copy
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.copy` copies a page and returns the identifier of the new page. This method can also copy a page marked as deleted and located in the trash.
operationId: landing_landing_copy
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-copy.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the source page.'
toSiteId:
type: integer
description: '| Identifier of the target site. If this parameter is not provided or set to `0`, the copy will be created in the same site where the source page is located.'
toFolderId:
type: integer
description: '| Identifier of the target folder. If this parameter is provided, the copy is created in the specified folder. The folder must belong to the target site `toSiteId`.'
skipSystem:
type: boolean
description: '| Flag for copying the system attribute of the page. Default is `false`.'
required:
- lid
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the source page.'
toSiteId:
type: integer
description: '| Identifier of the target site. If this parameter is not provided or set to `0`, the copy will be created in the same site where the source page is located.'
toFolderId:
type: integer
description: '| Identifier of the target folder. If this parameter is provided, the copy is created in the specified folder. The folder must belong to the target site `toSiteId`.'
skipSystem:
type: boolean
description: '| Flag for copying the system attribute of the page. Default is `false`.'
required:
- lid
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.copyblock:
post:
summary: Copy Block to Page landing.landing.copyblock
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.copyblock` copies a block to the specified page and returns the identifier of the created copy of the block. You can copy a block from another page or within the same page. The HTML content of the block is also copied.
operationId: landing_landing_copyblock
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-copy-block.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page to which the block should be copied.'
block:
type: integer
description: '| Identifier of the source block.'
params:
type: object
description: '| Additional copy parameters (detailed description) ||'
AFTER_ID:
type: integer
description: '| Identifier of the block on the page `lid`, after which the copy should be inserted.'
RETURN_CONTENT:
type: string
description: '| If you pass `Y`, the method will return an object with a success indicator and data of the created copy of the block (detailed description). For any other value, the method will return only the identifier of the created copy of the block ||'
required:
- lid
- block
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page to which the block should be copied.'
block:
type: integer
description: '| Identifier of the source block.'
params:
type: object
description: '| Additional copy parameters (detailed description) ||'
AFTER_ID:
type: integer
description: '| Identifier of the block on the page `lid`, after which the copy should be inserted.'
RETURN_CONTENT:
type: string
description: '| If you pass `Y`, the method will return an object with a success indicator and data of the created copy of the block (detailed description). For any other value, the method will return only the identifier of the created copy of the block ||'
required:
- lid
- block
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.delete:
post:
summary: Delete Page landing.landing.delete
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.delete` removes a page along with its blocks and associated files.
operationId: landing_landing_delete
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-delete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Page identifier.'
required:
- lid
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Page identifier.'
required:
- lid
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.deleteblock:
post:
summary: Delete Block from Page landing.landing.deleteblock
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.deleteblock` completely removes a block from the page. If the page is already published, changes will be visible to visitors after the "Publish Changes" command in the interface or after calling the method [landing.landing.publication](../methods/landing-landing-publication.md). Along with the block, associated data is deleted. Files and images are marked for deletion and will be automatically removed if they are not used elsewhere.
operationId: landing_landing_deleteblock
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-delete-block.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the editable version of the page.'
required:
- lid
- block
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the editable version of the page.'
required:
- lid
- block
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.downblock:
post:
summary: Move Block Down landing.landing.downblock
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.downblock` moves a block one position down in the page draft. If the page is already published, visitors will see the change after the "Publish Changes" command in the interface or after calling the method [landing.landing.publication](../methods/landing-landing-publication.md).
operationId: landing_landing_downblock
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-down-block.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Page identifier.'
block:
type: integer
description: '| Block identifier in the editable version of the page.'
preventHistory:
type: boolean
description: '| If `true`, the method does not add the action to the page change history. Default is `false` ||'
required:
- lid
- block
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Page identifier.'
block:
type: integer
description: '| Block identifier in the editable version of the page.'
preventHistory:
type: boolean
description: '| If `true`, the method does not add the action to the page change history. Default is `false` ||'
required:
- lid
- block
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.favoriteBlock:
post:
summary: Save to the list of blocks landing.landing.favoriteBlock
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.favoriteBlock` creates a copy of a page block and saves it to the block list as a template. Upon successful execution, the method returns the identifier of the new block copy.
operationId: landing_landing_favoriteBlock
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-favorite-block.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block.'
meta:
type: object
description: '| Parameters of the saved block (detailed description).'
name:
type: string
description: '| Name of the saved block copy in the block list.'
section:
type: array
items: {}
description: \| `string` | Section or list of sections where the saved block will be displayed. If the parameter is not provided, the block will be shown in the same sections as the original block.
preview:
type: integer
description: '| Identifier of the preview image file.'
tpl_code:
type: string
description: '| Template code of the page to which the saved block should be linked.'
required:
- lid
- block
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block.'
meta:
type: object
description: '| Parameters of the saved block (detailed description).'
name:
type: string
description: '| Name of the saved block copy in the block list.'
section:
type: array
items: {}
description: \| `string` | Section or list of sections where the saved block will be displayed. If the parameter is not provided, the block will be shown in the same sections as the original block.
preview:
type: integer
description: '| Identifier of the preview image file.'
tpl_code:
type: string
description: '| Template code of the page to which the saved block should be linked.'
required:
- lid
- block
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.getList:
post:
summary: Get a List of Pages landing.landing.getList
description: 'If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.getList` retrieves a list of pages based on the selection parameters. By default, the method returns only pages on non-deleted sites with `DELETED = "N"`. To retrieve deleted pages, pass `DELETED` or `=DELETED` in the filter. This only works for pages on non-deleted sites: the method does not return pages from deleted sites.'
operationId: landing_landing_getList
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-get-list.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landings. It is not related to the REST scope `landing` in the method name.'
params:
type: object
description: '| Parameters for selecting pages (detailed description) ||'
select:
type: string
description: '| List of fields to select from Page Object Fields. If the parameter is not passed or is equal to `null`, `["*"]` is used.'
filter:
type: object
description: '| Filter by fields from Page Object Fields. If the parameter is not passed or is in an incorrect format, the selection is performed without custom conditions. Keys with `.` and `CHECK_PERMISSIONS` are ignored.'
order:
type: object
description: '| Sorting in the format `{"FIELD": "ASC"}` or `{"FIELD": "DESC"}`. If the parameter is not passed, no special sorting is applied. ||'
group:
type: array
items: {}
description: '| Grouping in ORM format. The method does not have a default value. ||'
limit:
type: integer
description: '| Limit on the number of rows in the selection at the ORM level. The method does not set its own default limit. ||'
offset:
type: integer
description: '| Offset for the selection at the ORM level. ||'
get_preview:
type: boolean
description: \| `integer` | If the value evaluates to `true`, each result element includes a `PREVIEW` field with a link to the page preview. ||
get_urls:
type: boolean
description: \| `integer` | If the value evaluates to `true`, each result element includes a `PUBLIC_URL` field with the public address of the page. ||
check_area:
type: boolean
description: \| `integer` | If the value evaluates to `true`, each result element includes an `IS_AREA` field indicating whether the page is an included area. ||
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landings. It is not related to the REST scope `landing` in the method name.'
params:
type: object
description: '| Parameters for selecting pages (detailed description) ||'
select:
type: string
description: '| List of fields to select from Page Object Fields. If the parameter is not passed or is equal to `null`, `["*"]` is used.'
filter:
type: object
description: '| Filter by fields from Page Object Fields. If the parameter is not passed or is in an incorrect format, the selection is performed without custom conditions. Keys with `.` and `CHECK_PERMISSIONS` are ignored.'
order:
type: object
description: '| Sorting in the format `{"FIELD": "ASC"}` or `{"FIELD": "DESC"}`. If the parameter is not passed, no special sorting is applied. ||'
group:
type: array
items: {}
description: '| Grouping in ORM format. The method does not have a default value. ||'
limit:
type: integer
description: '| Limit on the number of rows in the selection at the ORM level. The method does not set its own default limit. ||'
offset:
type: integer
description: '| Offset for the selection at the ORM level. ||'
get_preview:
type: boolean
description: \| `integer` | If the value evaluates to `true`, each result element includes a `PREVIEW` field with a link to the page preview. ||
get_urls:
type: boolean
description: \| `integer` | If the value evaluates to `true`, each result element includes a `PUBLIC_URL` field with the public address of the page. ||
check_area:
type: boolean
description: \| `integer` | If the value evaluates to `true`, each result element includes an `IS_AREA` field indicating whether the page is an included area. ||
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.getadditionalfields:
post:
summary: Get Additional Fields of the Page landing.landing.getadditionalfields
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.getadditionalfields` retrieves [additional fields](../additional-fields.md) of the page.
operationId: landing_landing_getadditionalfields
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-get-additional-fields.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
required:
- lid
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
required:
- lid
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.getpreview:
post:
summary: Get the URL of the Preview for landing.landing.getpreview
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.getpreview` returns the URL or relative path to the preview image of the page.
operationId: landing_landing_getpreview
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-get-preview.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
required:
- lid
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
required:
- lid
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.getpublicurl:
post:
summary: Get Public URL of the Page landing.landing.getpublicurl
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.getpublicurl` returns the complete public URL of the page.
operationId: landing_landing_getpublicurl
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-get-public-url.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
required:
- lid
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
required:
- lid
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.hideblock:
post:
summary: Hide Block on Page landing.landing.hideblock
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.hideblock` hides a block on the page. The hidden block remains in the draft of the page and can be shown again using the method [landing.landing.showblock](./landing-landing-show-block.md). If the page is already published, the change will be visible to visitors after the "Publish Changes" command in the interface or after calling the method [landing.landing.publication](../methods/landing-landing-publication.md).
operationId: landing_landing_hideblock
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-hide-block.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block.'
required:
- lid
- block
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block.'
required:
- lid
- block
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.markDelete:
post:
summary: Mark Page as Deleted landing.landing.markDelete
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.markDelete` marks the page as deleted, moves it to the trash, and unpublishes it.
operationId: landing_landing_markDelete
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-mark-delete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
lid:
type: integer
description: '| Identifier of the page.'
required:
- lid
application/x-www-form-urlencoded:
schema:
type: object
properties:
lid:
type: integer
description: '| Identifier of the page.'
required:
- lid
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.markUnDelete:
post:
summary: Restore Page from Recycle Bin landing.landing.markUnDelete
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.markUnDelete` restores a page from the recycle bin and removes the deletion flag. After restoration, the page remains unpublished (`ACTIVE = "N"`).
operationId: landing_landing_markUnDelete
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-mark-undelete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
lid:
type: integer
description: '| Page identifier.'
required:
- lid
application/x-www-form-urlencoded:
schema:
type: object
properties:
lid:
type: integer
description: '| Page identifier.'
required:
- lid
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.markdeletedblock:
post:
summary: Mark a Block as Deleted landing.landing.markdeletedblock
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.markdeletedblock` marks a page block as deleted but does not remove it from the database. The marked block can be restored using the method [landing.landing.markundeletedblock](./landing-landing-mark-undeleted-block.md). If the page is already published, changes will be visible to visitors after the "Publish Changes" command in the interface or after calling the method [landing.landing.publication](../methods/landing-landing-publication.md).
operationId: landing_landing_markdeletedblock
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-mark-deleted-block.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block.'
mark:
type: boolean
description: '| Indicator for marking the block as deleted. Default is `true`.'
preventHistory:
type: boolean
description: '| If `true`, the method does not add the action to the page change history. Default is `false` ||'
required:
- lid
- block
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block.'
mark:
type: boolean
description: '| Indicator for marking the block as deleted. Default is `true`.'
preventHistory:
type: boolean
description: '| If `true`, the method does not add the action to the page change history. Default is `false` ||'
required:
- lid
- block
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.markundeletedblock:
post:
summary: Remove the deletion mark from the block landing.landing.markundeletedblock
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.markundeletedblock` removes the deletion mark from the block. If the page is already published, the changes will be visible to visitors after the "Publish changes" command in the interface or after calling the method [landing.landing.publication](../methods/landing-landing-publication.md). The method only removes the deletion mark. If the block was hidden before deletion, it will remain hidden after restoration. To show such a block again, use [landing.landing.showblock](./landing-landing-show-block.md).
operationId: landing_landing_markundeletedblock
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-mark-undeleted-block.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block.'
required:
- lid
- block
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block.'
required:
- lid
- block
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.move:
post:
summary: Move Page landing.landing.move
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.move` moves a page to another site or folder.
operationId: landing_landing_move
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-move.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page to be moved.'
toSiteId:
type: integer
description: '| Identifier of the destination site.'
toFolderId:
type: integer
description: '| Identifier of the destination folder in the target site.'
required:
- lid
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page to be moved.'
toSiteId:
type: integer
description: '| Identifier of the destination site.'
toFolderId:
type: integer
description: '| Identifier of the destination folder in the target site.'
required:
- lid
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.moveblock:
post:
summary: Move Block to Page landing.landing.moveblock
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.moveblock` moves a block to the specified page and returns the identifier of the moved block. The block can be moved within the same page or to another page. If the pages are already published, changes will be visible to visitors after the "Publish Changes" command in the interface or after calling the [landing.landing.publication](../methods/landing-landing-publication.md) method.
operationId: landing_landing_moveblock
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-move-block.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page to which the block needs to be moved.'
block:
type: integer
description: '| Identifier of the block.'
params:
type: object
description: '| Additional parameters for the move (detailed description) ||'
AFTER_ID:
type: integer
description: '| Identifier of the block on the page `lid`, after which the moved block should be placed.'
RETURN_CONTENT:
type: string
description: '| If set to `Y`, the method will return an object with a success flag and data of the moved block (detailed description). For any other value, the method will return only the identifier of the moved block. ||'
required:
- lid
- block
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page to which the block needs to be moved.'
block:
type: integer
description: '| Identifier of the block.'
params:
type: object
description: '| Additional parameters for the move (detailed description) ||'
AFTER_ID:
type: integer
description: '| Identifier of the block on the page `lid`, after which the moved block should be placed.'
RETURN_CONTENT:
type: string
description: '| If set to `Y`, the method will return an object with a success flag and data of the moved block (detailed description). For any other value, the method will return only the identifier of the moved block. ||'
required:
- lid
- block
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.publication:
post:
summary: Publish the landing.landing.publication page
description: 'If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.publication` publishes the page and makes it active. If the page is located in a folder, the method will publish that folder and all parent folders. After this, the site will become active. For Knowledge Base pages, the method manages the visibility of the page: making it available or hidden from users.'
operationId: landing_landing_publication
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-publication.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Page identifier.'
required:
- lid
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Page identifier.'
required:
- lid
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.removeEntities:
post:
summary: Remove Blocks and Clear Image File Bindings on Page landing.landing.removeEntities
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.removeEntities` removes specified blocks and their associated images from the page. It can also clear file bindings for individual images without deleting the blocks themselves.
operationId: landing_landing_removeEntities
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-remove-entities.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Page identifier.'
data:
type: object
description: '| Set of objects to be deleted (detailed description).'
blocks:
type: string
description: '| Identifiers of the page blocks to be completely removed.'
images:
type: string
description: '| Pairs of block and image identifiers for deleting file bindings. The content of the block remains unchanged — use this when the image has already been removed from the block and you need to clear the remaining service record. (detailed description).'
block:
type: integer
description: '| Identifier of the block associated with the image file binding ||'
image:
type: integer
description: '| Internal identifier of the image file binding (`FILE_ID`) associated with the block `block`.'
required:
- lid
- data
- block
- image
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Page identifier.'
data:
type: object
description: '| Set of objects to be deleted (detailed description).'
blocks:
type: string
description: '| Identifiers of the page blocks to be completely removed.'
images:
type: string
description: '| Pairs of block and image identifiers for deleting file bindings. The content of the block remains unchanged — use this when the image has already been removed from the block and you need to clear the remaining service record. (detailed description).'
block:
type: integer
description: '| Identifier of the block associated with the image file binding ||'
image:
type: integer
description: '| Internal identifier of the image file binding (`FILE_ID`) associated with the block `block`.'
required:
- lid
- data
- block
- image
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.resolveIdByPublicUrl:
post:
summary: Get Page ID by Public URL landing.landing.resolveIdByPublicUrl
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.resolveIdByPublicUrl` returns the page ID based on its public URL within the specified site.
operationId: landing_landing_resolveIdByPublicUrl
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-resolve-id-by-public-url.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
landingUrl:
type: string
description: '| Relative public URL of the page within the site `siteId`, for example `/catalog/sale/`.'
siteId:
type: integer
description: '| The ID of the site within which to find the page.'
required:
- landingUrl
- siteId
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
landingUrl:
type: string
description: '| Relative public URL of the page within the site `siteId`, for example `/catalog/sale/`.'
siteId:
type: integer
description: '| The ID of the site within which to find the page.'
required:
- landingUrl
- siteId
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.showblock:
post:
summary: Show Block on Page landing.landing.showblock
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.showblock` displays a block on the page that was previously hidden. If the page is already published, changes will be visible to visitors after the "Publish Changes" command in the interface or after calling the [landing.landing.publication](../methods/landing-landing-publication.md) method. If the block is marked as deleted, first restore it using the [landing.landing.markundeletedblock](./landing-landing-mark-undeleted-block.md) method.
operationId: landing_landing_showblock
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-show-block.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the editable version of the page.'
required:
- lid
- block
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the editable version of the page.'
required:
- lid
- block
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.unFavoriteBlock:
post:
summary: Remove from the saved list of blocks landing.landing.unFavoriteBlock
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.unFavoriteBlock` removes the saved copy of a block. The original block on the page remains unchanged. When a saved block is deleted, any associated files, such as a user-uploaded preview for that block, are also removed. You can only delete a saved block that the current user created using the method [landing.landing.favoriteBlock](./landing-landing-favorite-block.md).
operationId: landing_landing_unFavoriteBlock
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-unfavorite-block.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
blockId:
type: integer
description: '| Identifier of the saved copy of the block.'
required:
- blockId
application/x-www-form-urlencoded:
schema:
type: object
properties:
blockId:
type: integer
description: '| Identifier of the saved copy of the block.'
required:
- blockId
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.unpublic:
post:
summary: Unpublishing a Page landing.landing.unpublic
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.unpublic` unpublishes a page.
operationId: landing_landing_unpublic
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-unpublic.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
required:
- lid
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
required:
- lid
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.upblock:
post:
summary: Move Block Up landing.landing.upblock
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.upblock` moves a block one position up in the draft of the page. If the page is already published, the change will be visible to visitors after the "Publish Changes" command in the interface or after calling the method [landing.landing.publication](../methods/landing-landing-publication.md).
operationId: landing_landing_upblock
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/block-methods/landing-landing-up-block.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the editable version of the page.'
preventHistory:
type: boolean
description: '| If `true`, the method does not add the action to the page change history. Default is `false` ||'
required:
- lid
- block
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
lid:
type: integer
description: '| Identifier of the page.'
block:
type: integer
description: '| Identifier of the block in the editable version of the page.'
preventHistory:
type: boolean
description: '| If `true`, the method does not add the action to the page change history. Default is `false` ||'
required:
- lid
- block
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.landing.update:
post:
summary: Update Page landing.landing.update
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.landing.update` updates the parameters of the page.
operationId: landing_landing_update
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/methods/landing-landing-update.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
lid:
type: integer
description: '| The identifier of the page to be updated.'
fields:
type: object
description: '| A set of fields for the page to be updated (detailed description) ||'
TITLE:
type: string
description: '| The title of the page. ||'
CODE:
type: string
description: '| The symbolic code of the page. The code cannot contain the character `/` and must not be in the format `__`, for example `code_12_34`.'
DESCRIPTION:
type: string
description: '| A free-form description of the page. ||'
XML_ID:
type: string
description: '| The external identifier of the page. ||'
SITE_ID:
type: integer
description: '| The identifier of the site to which the page should be linked. If the parameter is not passed, the current site of the page is used.'
SITEMAP:
type: string
description: '| A flag to include the page in the sitemap. Supported values are `Y` and `N`. Any other value will be saved as `N`. ||'
FOLDER:
type: string
description: '| A folder indicator. Supported values are `Y` and `N`. Any other value will be saved as `N`. ||'
FOLDER_ID:
type: integer
description: '| The identifier of the folder in which to place the page. The folder must be within the current site of the page. If `0` is passed, the page will be moved to the root of the site.'
TPL_ID:
type: integer
description: '| The identifier of the page view template.'
DELETED:
type: string
description: '| Manages the state of the page in the trash. When this field is passed, the page becomes inactive.'
DATE_PUBLIC:
type: string
description: '| The date and time of the page publication.'
ADDITIONAL_FIELDS:
type: object
description: '| Additional fields of the page. Available codes and values are described in the article Additional Page Fields. ||'
required:
- lid
- fields
application/x-www-form-urlencoded:
schema:
type: object
properties:
lid:
type: integer
description: '| The identifier of the page to be updated.'
fields:
type: object
description: '| A set of fields for the page to be updated (detailed description) ||'
TITLE:
type: string
description: '| The title of the page. ||'
CODE:
type: string
description: '| The symbolic code of the page. The code cannot contain the character `/` and must not be in the format `__`, for example `code_12_34`.'
DESCRIPTION:
type: string
description: '| A free-form description of the page. ||'
XML_ID:
type: string
description: '| The external identifier of the page. ||'
SITE_ID:
type: integer
description: '| The identifier of the site to which the page should be linked. If the parameter is not passed, the current site of the page is used.'
SITEMAP:
type: string
description: '| A flag to include the page in the sitemap. Supported values are `Y` and `N`. Any other value will be saved as `N`. ||'
FOLDER:
type: string
description: '| A folder indicator. Supported values are `Y` and `N`. Any other value will be saved as `N`. ||'
FOLDER_ID:
type: integer
description: '| The identifier of the folder in which to place the page. The folder must be within the current site of the page. If `0` is passed, the page will be moved to the root of the site.'
TPL_ID:
type: integer
description: '| The identifier of the page view template.'
DELETED:
type: string
description: '| Manages the state of the page in the trash. When this field is passed, the page becomes inactive.'
DATE_PUBLIC:
type: string
description: '| The date and time of the page publication.'
ADDITIONAL_FIELDS:
type: object
description: '| Additional fields of the page. Available codes and values are described in the article Additional Page Fields. ||'
required:
- lid
- fields
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.repo.checkContent:
post:
summary: Check Content for Dangerous Substrings landing.repo.checkContent
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.repo.checkContent` checks content through a sanitizer.
operationId: landing_repo_checkContent
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/user-blocks/landing-repo-check-content.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
splitter:
type: string
description: '| A delimiter that marks dangerous fragments in `content`.'
application/x-www-form-urlencoded:
schema:
type: object
properties:
splitter:
type: string
description: '| A delimiter that marks dangerous fragments in `content`.'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.repo.getList:
post:
summary: Get a List of Custom Blocks landing.repo.getList
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.repo.getList` retrieves a list of custom blocks.
operationId: landing_repo_getList
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/user-blocks/landing-repo-get-list.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
params:
type: object
description: '| Object format:'
select:
type: string
description: '| Array format:'
filter:
type: object
description: '| Object format:'
order:
type: object
description: '| Object format:'
group:
type: array
items: {}
description: '| Array of fields for grouping the result.'
limit:
type: integer
description: '| Limit of records ||'
offset:
type: integer
description: '| Offset of records ||'
application/x-www-form-urlencoded:
schema:
type: object
properties:
params:
type: object
description: '| Object format:'
select:
type: string
description: '| Array format:'
filter:
type: object
description: '| Object format:'
order:
type: object
description: '| Object format:'
group:
type: array
items: {}
description: '| Array of fields for grouping the result.'
limit:
type: integer
description: '| Limit of records ||'
offset:
type: integer
description: '| Offset of records ||'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.repo.register:
post:
summary: Add a Custom Block to the Repository landing.repo.register
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.repo.register` adds a new custom block to the repository. The method updates the block if it already exists with the same code for the current application. If it does not exist, it creates a new one.
operationId: landing_repo_register
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/user-blocks/landing-repo-register.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
manifest:
type: object
description: '| Block manifest.'
DESCRIPTION:
type: string
description: '| Block description ||'
ACTIVE:
type: string
description: '| Block activity (`Y`/`N`) ||'
SITE_TEMPLATE_ID:
type: string
description: '| Binding of the block to the site template ||'
RESET:
type: string
description: '| If `Y` is passed, the method registers updates for blocks added to pages with the code `repo_` ||'
application/x-www-form-urlencoded:
schema:
type: object
properties:
manifest:
type: object
description: '| Block manifest.'
DESCRIPTION:
type: string
description: '| Block description ||'
ACTIVE:
type: string
description: '| Block activity (`Y`/`N`) ||'
SITE_TEMPLATE_ID:
type: string
description: '| Binding of the block to the site template ||'
RESET:
type: string
description: '| If `Y` is passed, the method registers updates for blocks added to pages with the code `repo_` ||'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.repo.unbind:
post:
summary: Remove Embedding Placement landing.repo.unbind
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.repo.unbind` removes the embedding placement registered by the current application in the `landing` section.
operationId: landing_repo_unbind
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/embedding/landing-repo-unbind.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
handler:
type: string
description: '| Path of the embedding placement handler.'
application/x-www-form-urlencoded:
schema:
type: object
properties:
handler:
type: string
description: '| Path of the embedding placement handler.'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.repo.unregister:
post:
summary: Delete User Block landing.repo.unregister
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.repo.unregister` deletes a user block by its code.
operationId: landing_repo_unregister
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/user-blocks/landing-repo-unregister.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
application/x-www-form-urlencoded:
schema:
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.role.enable:
post:
summary: Enable or Disable Role-Based Access Model landing.role.enable
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.role.enable` enables or disables the role-based access model for the "Sites and Stores" section.
operationId: landing_role_enable
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/rights/landing-role-enable.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
mode:
type: integer
description: '| Access model mode. You can check the current model using the landing.role.isEnabled method. Possible values:'
required:
- mode
application/x-www-form-urlencoded:
schema:
type: object
properties:
mode:
type: integer
description: '| Access model mode. You can check the current model using the landing.role.isEnabled method. Possible values:'
required:
- mode
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.role.getList:
post:
summary: Get the List of Roles landing.role.getList
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.role.getList` retrieves a list of access roles for the selected type of sites.
operationId: landing_role_getList
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/rights/role-model/landing-role-get-list.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| The type of sites for which roles need to be retrieved. This parameter is not related to the REST scope `landing` in the method name.'
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| The type of sites for which roles need to be retrieved. This parameter is not related to the REST scope `landing` in the method name.'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.role.getRights:
post:
summary: Get Role Rights with landing.role.getRights
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.role.getRights` returns the rights of the specified role for each site where they are configured.
operationId: landing_role_getRights
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/rights/role-model/landing-role-get-rights.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| Role identifier. You can obtain the identifier using the landing.role.getList method ||'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| Role identifier. You can obtain the identifier using the landing.role.getList method ||'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.role.isEnabled:
post:
summary: 'Check if the role model of permissions is enabled: landing.role.isEnabled'
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.role.isEnabled` checks whether the role model of permissions is enabled for the "Sites and Stores" section.
operationId: landing_role_isEnabled
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/rights/landing-role-is-enabled.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
application/x-www-form-urlencoded:
schema:
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.role.setAccessCodes:
post:
summary: Set Access Codes for Role landing.role.setAccessCodes
description: 'If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.role.setAccessCodes` specifies to whom the role is assigned: users, groups, or departments. After invocation, the method reapplies the already saved permissions of this role for the sites.'
operationId: landing_role_setAccessCodes
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/rights/role-model/landing-role-set-access-codes.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| Role identifier. You can obtain the identifier using the method landing.role.getList ||'
codes:
type: string
description: '| The final list of access codes for the role.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| Role identifier. You can obtain the identifier using the method landing.role.getList ||'
codes:
type: string
description: '| The final list of access codes for the role.'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.role.setRights:
post:
summary: Set Role Permissions for the Site List landing.role.setRights
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.role.setRights` sets role permissions for sites. You can specify separate permissions for each site, while others will have default permissions. The new set of permissions completely replaces the previous one.
operationId: landing_role_setRights
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/rights/role-model/landing-role-set-rights.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| The identifier of the role for which permissions need to be updated.'
rights:
type: object
description: '\| `array` | An object in the following format:'
additional:
type: string
description: '| Additional capabilities of the role.'
Code:
type: string
description: '| Description ||'
required:
- id
- rights
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| The identifier of the role for which permissions need to be updated.'
rights:
type: object
description: '\| `array` | An object in the following format:'
additional:
type: string
description: '| Additional capabilities of the role.'
Code:
type: string
description: '| Description ||'
required:
- id
- rights
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.add:
post:
summary: Add site landing.site.add
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.add` creates a new site and returns the identifier of the created site.
operationId: landing_site_add
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-add.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
fields:
type: object
description: '| Set of fields for the new site (detailed description) ||'
TITLE:
type: string
description: '| Title of the site, up to `255` characters ||'
CODE:
type: string
description: '| 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.'
TYPE:
type: string
description: '| Type of the site. Default is `PAGE`. Supported types are `PAGE`, `STORE`, `SMN`, `KNOWLEDGE`, `GROUP`, `MAINPAGE`.'
DOMAIN_ID:
type: integer
description: \| `string` | Domain of the site. The value depends on the platform.
DESCRIPTION:
type: string
description: '| Description of the site, up to `255` characters ||'
XML_ID:
type: string
description: '| External identifier, up to `255` characters ||'
ADDITIONAL_FIELDS:
type: object
description: '| Additional fields of the site, stored separately after creation ||'
fields.TYPE:
type: string
description: '| scope in request | When to use ||'
required:
- fields
- TITLE
- CODE
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
fields:
type: object
description: '| Set of fields for the new site (detailed description) ||'
TITLE:
type: string
description: '| Title of the site, up to `255` characters ||'
CODE:
type: string
description: '| 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.'
TYPE:
type: string
description: '| Type of the site. Default is `PAGE`. Supported types are `PAGE`, `STORE`, `SMN`, `KNOWLEDGE`, `GROUP`, `MAINPAGE`.'
DOMAIN_ID:
type: integer
description: \| `string` | Domain of the site. The value depends on the platform.
DESCRIPTION:
type: string
description: '| Description of the site, up to `255` characters ||'
XML_ID:
type: string
description: '| External identifier, up to `255` characters ||'
ADDITIONAL_FIELDS:
type: object
description: '| Additional fields of the site, stored separately after creation ||'
fields.TYPE:
type: string
description: '| scope in request | When to use ||'
required:
- fields
- TITLE
- CODE
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.addFolder:
post:
summary: Add Folder to Site landing.site.addFolder
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.addFolder` creates a folder in the specified site and returns the identifier of the created folder.
operationId: landing_site_addFolder
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-add-folder.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
siteId:
type: integer
description: '| Identifier of the site where the folder needs to be created.'
fields:
type: object
description: '| Set of fields for the folder being created (detailed description) ||'
TITLE:
type: string
description: '| Title of the folder, maximum length `255` characters ||'
CODE:
type: string
description: '| Symbolic code of the folder for the URL, maximum length `255` characters. If not provided or empty, the code is generated from `TITLE` using transliteration.'
PARENT_ID:
type: integer
description: '| Identifier of the parent folder. If the value is `0`, `null`, or empty, the folder is created at the root of the site ||'
ACTIVE:
type: string
description: '| Flag indicating the folder''s activity `Y/N`, default is `N` ||'
required:
- siteId
- fields
- TITLE
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
siteId:
type: integer
description: '| Identifier of the site where the folder needs to be created.'
fields:
type: object
description: '| Set of fields for the folder being created (detailed description) ||'
TITLE:
type: string
description: '| Title of the folder, maximum length `255` characters ||'
CODE:
type: string
description: '| Symbolic code of the folder for the URL, maximum length `255` characters. If not provided or empty, the code is generated from `TITLE` using transliteration.'
PARENT_ID:
type: integer
description: '| Identifier of the parent folder. If the value is `0`, `null`, or empty, the folder is created at the root of the site ||'
ACTIVE:
type: string
description: '| Flag indicating the folder''s activity `Y/N`, default is `N` ||'
required:
- siteId
- fields
- TITLE
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.bindingToGroup:
post:
summary: Bind to Social Network Group landing.site.bindingToGroup
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.bindingToGroup` binds the Knowledge Base to a Social Network group.
operationId: landing_site_bindingToGroup
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/embedding/knowledge-base/landing-site-binding-to-group.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
application/x-www-form-urlencoded:
schema:
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.bindingToMenu:
post:
summary: Bind Knowledge Base to Menu landing.site.bindingToMenu
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.bindingToMenu` binds the Knowledge Base to the specified menu.
operationId: landing_site_bindingToMenu
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/embedding/knowledge-base/landing-site-binding-to-menu.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
application/x-www-form-urlencoded:
schema:
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.delete:
post:
summary: Delete Site landing.site.delete
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.delete` only deletes an empty site without pages.
operationId: landing_site_delete
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-delete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope for landings. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Site identifier'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope for landings. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Site identifier'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.fullExport:
post:
summary: Exporting the site landing.site.fullExport
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.fullExport` exports the site and its pages into an array for subsequent import, for example, via [landing.demos.register](../demos/landing-demos-register.md).
operationId: landing_site_fullExport
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-full-export.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| Site identifier.'
params:
type: object
description: '| Additional export parameters (detailed description) ||'
edit_mode:
type: string
description: '| Hook export mode. When set to `Y`, edit mode is enabled. The default is standard mode ||'
scope:
type: string
description: '| Internal scope of the landings. It is not related to the REST scope `landing` or `landing_cloud` in the method name.'
hooks_disable:
type: string
description: '| Codes of additional fields to be excluded from `ADDITIONAL_FIELDS` at the site and page level.'
code:
type: string
description: '| Code of the exported site. If not provided, the current site code is used without leading or trailing `/`.'
name:
type: string
description: '| Name of the site in the export. If not provided, the current site name is used ||'
description:
type: string
description: '| Description of the site in the export. If not provided, the current site description is used ||'
preview:
type: string
description: '| URL of the main preview image. Defaults to an empty string ||'
preview2x:
type: string
description: '| URL of the enlarged preview image. Defaults to an empty string ||'
preview3x:
type: string
description: '| URL of the retina preview. Defaults to an empty string ||'
preview_url:
type: string
description: '| URL of the template preview. Defaults to an empty string ||'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| Site identifier.'
params:
type: object
description: '| Additional export parameters (detailed description) ||'
edit_mode:
type: string
description: '| Hook export mode. When set to `Y`, edit mode is enabled. The default is standard mode ||'
scope:
type: string
description: '| Internal scope of the landings. It is not related to the REST scope `landing` or `landing_cloud` in the method name.'
hooks_disable:
type: string
description: '| Codes of additional fields to be excluded from `ADDITIONAL_FIELDS` at the site and page level.'
code:
type: string
description: '| Code of the exported site. If not provided, the current site code is used without leading or trailing `/`.'
name:
type: string
description: '| Name of the site in the export. If not provided, the current site name is used ||'
description:
type: string
description: '| Description of the site in the export. If not provided, the current site description is used ||'
preview:
type: string
description: '| URL of the main preview image. Defaults to an empty string ||'
preview2x:
type: string
description: '| URL of the enlarged preview image. Defaults to an empty string ||'
preview3x:
type: string
description: '| URL of the retina preview. Defaults to an empty string ||'
preview_url:
type: string
description: '| URL of the template preview. Defaults to an empty string ||'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.getFolders:
post:
summary: Get Site Folders landing.site.getFolders
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.getFolders` returns a list of site folders.
operationId: landing_site_getFolders
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-get-folders.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
siteId:
type: integer
description: '| Identifier of the site for which folders are requested.'
filter:
type: object
description: '| Filter by folder fields (detailed description) ||'
ID:
type: integer
description: '| Identifier of the folder ||'
PARENT_ID:
type: integer
description: \| `null` | Identifier of the parent folder. If `0`, `null`, `false`, or an empty string is passed, the value will be converted to `null`, which selects top-level folders ||
INDEX_ID:
type: integer
description: '| Identifier of the folder''s index page ||'
ACTIVE:
type: string
description: '| Active flag `Y/N` ||'
DELETED:
type: string
description: '| Deletion flag `Y/N` ||'
TITLE:
type: string
description: '| Title of the folder ||'
CODE:
type: string
description: '| Symbolic code of the folder ||'
CREATED_BY_ID:
type: integer
description: '| Identifier of the user who created the folder ||'
MODIFIED_BY_ID:
type: integer
description: '| Identifier of the user who modified the folder ||'
DATE_CREATE:
type: string
format: date-time
description: '| Date and time of folder creation ||'
DATE_MODIFY:
type: string
format: date-time
description: '| Date and time of folder modification ||'
required:
- siteId
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
siteId:
type: integer
description: '| Identifier of the site for which folders are requested.'
filter:
type: object
description: '| Filter by folder fields (detailed description) ||'
ID:
type: integer
description: '| Identifier of the folder ||'
PARENT_ID:
type: integer
description: \| `null` | Identifier of the parent folder. If `0`, `null`, `false`, or an empty string is passed, the value will be converted to `null`, which selects top-level folders ||
INDEX_ID:
type: integer
description: '| Identifier of the folder''s index page ||'
ACTIVE:
type: string
description: '| Active flag `Y/N` ||'
DELETED:
type: string
description: '| Deletion flag `Y/N` ||'
TITLE:
type: string
description: '| Title of the folder ||'
CODE:
type: string
description: '| Symbolic code of the folder ||'
CREATED_BY_ID:
type: integer
description: '| Identifier of the user who created the folder ||'
MODIFIED_BY_ID:
type: integer
description: '| Identifier of the user who modified the folder ||'
DATE_CREATE:
type: string
format: date-time
description: '| Date and time of folder creation ||'
DATE_MODIFY:
type: string
format: date-time
description: '| Date and time of folder modification ||'
required:
- siteId
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.getGroupBindings:
post:
summary: Get Group Bindings - landing.site.getGroupBindings
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.getGroupBindings` returns the bindings of Knowledge Bases to groups.
operationId: landing_site_getGroupBindings
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/embedding/knowledge-base/landing-site-get-group-bindings.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
groupId:
type: integer
description: \| `null` | The identifier of the group for filtering.
application/x-www-form-urlencoded:
schema:
type: object
properties:
groupId:
type: integer
description: \| `null` | The identifier of the group for filtering.
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.getList:
post:
summary: Get the List of Sites landing.site.getList
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.getList` retrieves a list of sites based on the selection parameters. By default, only sites with `DELETED = "N"` are included in the selection. To retrieve deleted sites, pass `DELETED` or `=DELETED` in the filter.
operationId: landing_site_getList
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-get-list.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
params:
type: object
description: '| Parameters for selecting sites (detailed description) ||'
select:
type: string
description: '| List of fields to select from basic site fields. If the parameter is not passed or is not an array, `["*"]` is used. The method always adds `ID` and `TYPE` to the selection. ||'
filter:
type: object
description: '| Filter by fields from basic site fields. If the parameter is not passed or is not an array, an empty filter `{}` is used.'
order:
type: object
description: '| Sorting in the format `{"FIELD": "ASC DESC"}`. If the parameter is not passed, no special sorting is applied. ||'
group:
type: array
items: {}
description: '| Grouping in ORM format. If not an array, the parameter is converted to an empty array. When filtering by access rights, `ID` is added to the grouping. ||'
limit:
type: integer
description: '| Limit on the number of rows in the selection at the ORM level. By default, it is not set. ||'
offset:
type: integer
description: '| Offset for the selection at the ORM level. If the parameter is not passed, the default ORM behavior is applied. ||'
params.filter.TYPE:
type: string
description: '| scope in request | When to use ||'
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
params:
type: object
description: '| Parameters for selecting sites (detailed description) ||'
select:
type: string
description: '| List of fields to select from basic site fields. If the parameter is not passed or is not an array, `["*"]` is used. The method always adds `ID` and `TYPE` to the selection. ||'
filter:
type: object
description: '| Filter by fields from basic site fields. If the parameter is not passed or is not an array, an empty filter `{}` is used.'
order:
type: object
description: '| Sorting in the format `{"FIELD": "ASC DESC"}`. If the parameter is not passed, no special sorting is applied. ||'
group:
type: array
items: {}
description: '| Grouping in ORM format. If not an array, the parameter is converted to an empty array. When filtering by access rights, `ID` is added to the grouping. ||'
limit:
type: integer
description: '| Limit on the number of rows in the selection at the ORM level. By default, it is not set. ||'
offset:
type: integer
description: '| Offset for the selection at the ORM level. If the parameter is not passed, the default ORM behavior is applied. ||'
params.filter.TYPE:
type: string
description: '| scope in request | When to use ||'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.getMenuBindings:
post:
summary: Get Menu Bindings with landing.site.getMenuBindings
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.getMenuBindings` returns Knowledge Base bindings to the menu.
operationId: landing_site_getMenuBindings
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/embedding/knowledge-base/landing-site-get-menu-bindings.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
menuCode:
type: string
description: \| `null` | Menu code for filtering.
application/x-www-form-urlencoded:
schema:
type: object
properties:
menuCode:
type: string
description: \| `null` | Menu code for filtering.
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.getPreview:
post:
summary: Get URL Preview of the Site landing.site.getPreview
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.getPreview` returns the URL preview of the site's index page.
operationId: landing_site_getPreview
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-get-preview.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Site identifier.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Site identifier.'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.getPublicUrl:
post:
summary: Get Public URL of the Site landing.site.getPublicUrl
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.getPublicUrl` returns the complete public URL of a site or multiple sites.
operationId: landing_site_getPublicUrl
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-get-public-url.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: \| `array` | Identifier of the site or an array of site identifiers. If a single identifier is provided, the `result` will return a URL string.
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: \| `array` | Identifier of the site or an array of site identifiers. If a single identifier is provided, the `result` will return a URL string.
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.getRights:
post:
summary: Get Access Permissions for landing.site.getRights
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.getRights` retrieves the list of permissions for the current user for the specified site.
operationId: landing_site_getRights
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/rights/extended-model/landing-site-get-rights.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: \| `string` | Identifier of the site.
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: \| `string` | Identifier of the site.
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.getadditionalfields:
post:
summary: Get Additional Fields of the Site landing.site.getadditionalfields
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.getadditionalfields` retrieves additional fields of the site.
operationId: landing_site_getadditionalfields
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-get-additional-fields.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Identifier of the site.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Identifier of the site.'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.markDelete:
post:
summary: Mark the site as deleted landing.site.markDelete
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.markDelete` marks the site as deleted and moves it to the trash.
operationId: landing_site_markDelete
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-mark-delete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Identifier of the site.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Identifier of the site.'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.markFolderDelete:
post:
summary: Mark a Folder as Deleted landing.site.markFolderDelete
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.markFolderDelete` marks a folder as deleted and moves it to the trash. Upon successful execution, the method also marks the pages within this folder and any nested folders as deleted.
operationId: landing_site_markFolderDelete
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-mark-folder-delete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Identifier of the folder.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Identifier of the folder.'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.markFolderUnDelete:
post:
summary: Restore Folder from Recycle Bin landing.site.markFolderUnDelete
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.markFolderUnDelete` restores a folder from the recycle bin and removes the deletion mark from this folder and the pages within it.
operationId: landing_site_markFolderUnDelete
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-mark-folder-undelete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Identifier of the folder.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Identifier of the folder.'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.markUnDelete:
post:
summary: Restore Site from Recycle Bin landing.site.markUnDelete
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.markUnDelete` restores a site from the recycle bin and removes the deletion flag. After restoration, the site remains unpublished (`ACTIVE = "N"`).
operationId: landing_site_markUnDelete
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-mark-undelete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Identifier of the site.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of landings. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Identifier of the site.'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.publication:
post:
summary: Publish the site landing.site.publication
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.publication` publishes the site and its pages. If a page is inactive (`ACTIVE = "N"`), it remains unpublished (`PUBLIC = "N"`). When the method is called, non-deleted site folders (`DELETED = "N"`) are also activated. For the Knowledge Base, the method manages the visibility of the site and its pages for users.
operationId: landing_site_publication
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-publication.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Identifier of the site.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Identifier of the site.'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.publicationFolder:
post:
summary: Publish the Website Folder landing.site.publicationFolder
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.publicationFolder` publishes the website folder and its chain of parent folders.
operationId: landing_site_publicationFolder
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-publication-folder.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
folderId:
type: integer
description: '| Identifier of the folder.'
mark:
type: boolean
description: '| Publication flag. `true` (default) publishes the folder, `false` unpublishes the folder.'
required:
- folderId
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
folderId:
type: integer
description: '| Identifier of the folder.'
mark:
type: boolean
description: '| Publication flag. `true` (default) publishes the folder, `false` unpublishes the folder.'
required:
- folderId
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.setRights:
post:
summary: Set Access Permissions for landing.site.setRights
description: 'If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.setRights` sets access permissions in the advanced permission model for the specified site. This method only works in the advanced permission model. If the role model is enabled in the "Sites and Stores" section, the call will return `true`, but the saved permissions will not be applied. To enable the advanced permission model, use the method [landing.role.enable](../landing-role-enable.md) with the value `mode: 0`.'
operationId: landing_site_setRights
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/rights/extended-model/landing-site-set-rights.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: \| `string` | Site identifier.
rights:
type: object
description: '\| `array` | Object format:'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: \| `string` | Site identifier.
rights:
type: object
description: '\| `array` | Object format:'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.unPublicFolder:
post:
summary: Unpublishing a Website Folder landing.site.unPublicFolder
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.unPublicFolder` unpublishes a website folder and its parent folder chain.
operationId: landing_site_unPublicFolder
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-unpublic-folder.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
folderId:
type: integer
description: '| Identifier of the folder.'
required:
- folderId
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing pages. It is not related to the REST scope `landing` in the method name.'
folderId:
type: integer
description: '| Identifier of the folder.'
required:
- folderId
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.unbindingFromGroup:
post:
summary: Unbind Knowledge Base from Social Network Group landing.site.unbindingFromGroup
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.unbindingFromGroup` removes the binding of the Knowledge Base to a Social Network group.
operationId: landing_site_unbindingFromGroup
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/embedding/knowledge-base/landing-site-unbinding-from-group.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
application/x-www-form-urlencoded:
schema:
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.unbindingFromMenu:
post:
summary: Unbind Knowledge Base from Menu landing.site.unbindingFromMenu
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.unbindingFromMenu` removes the binding of the Knowledge Base from the specified menu.
operationId: landing_site_unbindingFromMenu
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/embedding/knowledge-base/landing-site-unbinding-from-menu.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
application/x-www-form-urlencoded:
schema:
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.unpublic:
post:
summary: Unpublishing a Site landing.site.unpublic
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.unpublic` unpublishes the site and its pages, deactivating the site. For all non-deleted folders of the site, the method also disables activity. For the Knowledge Base, the method hides the site and its pages from users.
operationId: landing_site_unpublic
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-unpublic.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Identifier of the site.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Identifier of the site.'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.update:
post:
summary: Update Site landing.site.update
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.update` updates the parameters of the site.
operationId: landing_site_update
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-update.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Identifier of the site.'
fields:
type: object
description: '| Set of fields to update the site (detailed description) ||'
TITLE:
type: string
description: '| Title of the site, up to `255` characters ||'
CODE:
type: string
description: '| Symbolic code of the site. If an empty string is passed, the code is generated from `TITLE` or from the string `site`.'
TYPE:
type: string
description: '| Type of the site. Supported types are `PAGE`, `STORE`, `SMN`, `KNOWLEDGE`, `GROUP`, `MAINPAGE`.'
DOMAIN_ID:
type: integer
description: \| `string` | Domain of the site. Usually, the domain name is passed. For sites of types `PAGE`, `STORE`, `SMN`, if the parameter is not passed or an empty string is provided, the parameter value is ignored. For `GROUP`, `KNOWLEDGE`, and `MAINPAGE`, the parameter is usually not passed.
DESCRIPTION:
type: string
description: '| Description of the site, up to `255` characters ||'
XML_ID:
type: string
description: '| External identifier of the site ||'
LANDING_ID_INDEX:
type: integer
description: '| Identifier of the site page that will be the main one ||'
LANDING_ID_404:
type: integer
description: '| Identifier of the 404 error page ||'
LANDING_ID_503:
type: integer
description: '| Identifier of the 503 error page ||'
required:
- id
- fields
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
id:
type: integer
description: '| Identifier of the site.'
fields:
type: object
description: '| Set of fields to update the site (detailed description) ||'
TITLE:
type: string
description: '| Title of the site, up to `255` characters ||'
CODE:
type: string
description: '| Symbolic code of the site. If an empty string is passed, the code is generated from `TITLE` or from the string `site`.'
TYPE:
type: string
description: '| Type of the site. Supported types are `PAGE`, `STORE`, `SMN`, `KNOWLEDGE`, `GROUP`, `MAINPAGE`.'
DOMAIN_ID:
type: integer
description: \| `string` | Domain of the site. Usually, the domain name is passed. For sites of types `PAGE`, `STORE`, `SMN`, if the parameter is not passed or an empty string is provided, the parameter value is ignored. For `GROUP`, `KNOWLEDGE`, and `MAINPAGE`, the parameter is usually not passed.
DESCRIPTION:
type: string
description: '| Description of the site, up to `255` characters ||'
XML_ID:
type: string
description: '| External identifier of the site ||'
LANDING_ID_INDEX:
type: integer
description: '| Identifier of the site page that will be the main one ||'
LANDING_ID_404:
type: integer
description: '| Identifier of the 404 error page ||'
LANDING_ID_503:
type: integer
description: '| Identifier of the 503 error page ||'
required:
- id
- fields
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.site.updateFolder:
post:
summary: Change Folder in landing.site.updateFolder
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.site.updateFolder` updates the parameters of a site folder.
operationId: landing_site_updateFolder
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/site/landing-site-update-folder.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
siteId:
type: integer
description: '| Identifier of the site to which the folder belongs.'
folderId:
type: integer
description: '| Identifier of the folder to be updated.'
fields:
type: object
description: '| Set of fields to update the folder (detailed description) ||'
TITLE:
type: string
description: '| Title of the folder ||'
CODE:
type: string
description: '| Symbolic code of the folder for the URL. The code cannot contain the character `/`.'
PARENT_ID:
type: integer
description: '| Identifier of the parent folder.'
INDEX_ID:
type: integer
description: '| Identifier of the index page of the folder ||'
ACTIVE:
type: string
description: '| Active flag for the folder `Y/N` ||'
required:
- siteId
- folderId
- fields
application/x-www-form-urlencoded:
schema:
type: object
properties:
scope:
type: string
description: '| Internal scope of the landing. It is not related to the REST scope `landing` in the method name.'
siteId:
type: integer
description: '| Identifier of the site to which the folder belongs.'
folderId:
type: integer
description: '| Identifier of the folder to be updated.'
fields:
type: object
description: '| Set of fields to update the folder (detailed description) ||'
TITLE:
type: string
description: '| Title of the folder ||'
CODE:
type: string
description: '| Symbolic code of the folder for the URL. The code cannot contain the character `/`.'
PARENT_ID:
type: integer
description: '| Identifier of the parent folder.'
INDEX_ID:
type: integer
description: '| Identifier of the index page of the folder ||'
ACTIVE:
type: string
description: '| Active flag for the folder `Y/N` ||'
required:
- siteId
- folderId
- fields
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.syspage.deleteForLanding:
post:
summary: Delete All Page Bindings as Special landing.syspage.deleteForLanding
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.syspage.deleteForLanding` removes all bindings where the page with the identifier `id` is designated as special for the site. This method does not delete sites or pages. It only removes bindings of special pages. If the same page is designated as special for multiple sites, the method will delete all such bindings at once.
operationId: landing_syspage_deleteForLanding
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-delete-for-landing.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| The identifier of the page for which all special bindings need to be removed.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| The identifier of the page for which all special bindings need to be removed.'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.syspage.deleteForSite:
post:
summary: Delete All Bindings of Special Pages for Site landing.syspage.deleteForSite
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.syspage.deleteForSite` removes all bindings of special pages for the site. This method does not delete the site or the pages themselves. It only removes the records of the bindings of special pages. All found bindings for the specified site are deleted in a single call.
operationId: landing_syspage_deleteForSite
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-delete-for-site.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| The identifier of the site for which all bindings of special pages need to be deleted.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| The identifier of the site for which all bindings of special pages need to be deleted.'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.syspage.get:
post:
summary: Get a List of Special Pages from landing.syspage.get
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.syspage.get` returns a list of special pages for the site.
operationId: landing_syspage_get
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-get.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| Identifier of the site.'
active:
type: boolean
description: '| Return only pages that are not deleted and are active.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| Identifier of the site.'
active:
type: boolean
description: '| Return only pages that are not deleted and are active.'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.syspage.getSpecialPage:
post:
summary: Get the URL of the special page using landing.syspage.getSpecialPage
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.syspage.getSpecialPage` returns the URL of the special page for the site.
operationId: landing_syspage_getSpecialPage
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-get-special-page.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
siteId:
type: integer
description: '| The site identifier.'
type:
type: string
description: '| The code of the special page that the method looks for in the site''s bindings.'
additional:
type: object
description: '| Additional URL parameters (detailed description).'
required:
- siteId
- type
application/x-www-form-urlencoded:
schema:
type: object
properties:
siteId:
type: integer
description: '| The site identifier.'
type:
type: string
description: '| The code of the special page that the method looks for in the site''s bindings.'
additional:
type: object
description: '| Additional URL parameters (detailed description).'
required:
- siteId
- type
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.syspage.set:
post:
summary: Set a Special Page for the Site landing.syspage.set
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.syspage.set` assigns a special page for the site.
operationId: landing_syspage_set
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/page/special-pages/landing-syspage-set.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| Site identifier.'
type:
type: string
description: '| Code for the special page.'
lid:
type: integer
description: '| Identifier of the page to be set as special for the site.'
required:
- id
- type
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| Site identifier.'
type:
type: string
description: '| Code for the special page.'
lid:
type: integer
description: '| Identifier of the page to be set as special for the site.'
required:
- id
- type
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.template.getLandingRef:
post:
summary: Get a List of Included Areas for the landing.template.getLandingRef Page
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.template.getLandingRef` retrieves a list of included areas associated with the page. The response includes only the bindings saved for the page. Bindings configured at the site level are not returned by this method. To obtain them, use the method [landing.template.getSiteRef](./landing-template-get-site-ref.md).
operationId: landing_template_getLandingRef
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-get-landing-ref.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| The identifier of the page.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| The identifier of the page.'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.template.getSiteRef:
post:
summary: Get a List of Included Areas for the Site landing.template.getSiteRef
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.template.getSiteRef` retrieves a list of included areas associated with the site. The response includes only the bindings saved for the site. Bindings configured for individual pages of this site are not returned by the method. To obtain them, use [landing.template.getLandingRef](./landing-template-get-landing-ref.md).
operationId: landing_template_getSiteRef
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-get-site-ref.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| Identifier of the site.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| Identifier of the site.'
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.template.getlist:
post:
summary: Get a List of View Templates landing.template.getlist
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.template.getlist` retrieves a list of view templates for the current account based on the selection parameters.
operationId: landing_template_getlist
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-get-list.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
params:
type: object
description: '| An object containing the selection parameters for view templates in the following format:'
select:
type: string
description: '| A list of fields from the fields of the View Template object.'
filter:
type: object
description: '| A filter for fields from the fields of the View Template object.'
order:
type: object
description: '| Sorting in the format `{"FIELD": "ASC"}` or `{"FIELD": "DESC"}`.'
group:
type: array
items: {}
description: '| An array of field names for grouping, such as `["ACTIVE"]` or `["ACTIVE", "SORT"]`.'
limit:
type: integer
description: '| The maximum number of items in the response.'
offset:
type: integer
description: '| The offset from the start of the selection. Use together with `limit` for pagination ||'
application/x-www-form-urlencoded:
schema:
type: object
properties:
params:
type: object
description: '| An object containing the selection parameters for view templates in the following format:'
select:
type: string
description: '| A list of fields from the fields of the View Template object.'
filter:
type: object
description: '| A filter for fields from the fields of the View Template object.'
order:
type: object
description: '| Sorting in the format `{"FIELD": "ASC"}` or `{"FIELD": "DESC"}`.'
group:
type: array
items: {}
description: '| An array of field names for grouping, such as `["ACTIVE"]` or `["ACTIVE", "SORT"]`.'
limit:
type: integer
description: '| The maximum number of items in the response.'
offset:
type: integer
description: '| The offset from the start of the selection. Use together with `limit` for pagination ||'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.template.setLandingRef:
post:
summary: Set Included Areas for landing.template.setLandingRef Page
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.template.setLandingRef` sets the bindings of included areas for the page. It only works with page bindings and does not alter site bindings. Included areas of the template are separate pages used as parts of the layout, such as the header, footer, or sidebar.
operationId: landing_template_setLandingRef
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-set-landing-ref.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| Identifier of the page.'
data:
type: object
description: \| `array` | Set of bindings for the included areas of the page. (detailed description)
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| Identifier of the page.'
data:
type: object
description: \| `array` | Set of bindings for the included areas of the page. (detailed description)
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
/landing.template.setSiteRef:
post:
summary: Set Included Areas for the Site landing.template.setSiteRef
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `landing.template.setSiteRef` saves the bindings of included areas for the site. It only works with site bindings and does not change the bindings of individual pages.
operationId: landing_template_setSiteRef
tags:
- Sites
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/landing/template/landing-template-set-site-ref.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| Site identifier.'
data:
type: object
description: \| `array` | A set of bindings for the included areas of the site (detailed description).
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| Site identifier.'
data:
type: object
description: \| `array` | A set of bindings for the included areas of the site (detailed description).
required:
- id
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- landing
components:
schemas:
BitrixError:
type: object
description: Bitrix24 REST API error response
required:
- error
- error_description
properties:
error:
type: string
description: Error code
example: ACCESS_DENIED
error_description:
type: string
description: Human-readable error description
example: Access denied.
BitrixTime:
type: object
description: Request execution time information
properties:
start:
type: number
format: double
finish:
type: number
format: double
duration:
type: number
format: double
processing:
type: number
format: double
date_start:
type: string
format: date-time
date_finish:
type: string
format: date-time
operating_reset_at:
type: integer
operating:
type: number
format: double
BitrixResponse:
type: object
description: Standard Bitrix24 REST API response
properties:
result:
description: Method execution result
total:
type: integer
description: Total number of records (for list methods)
next:
type: integer
description: Next offset for pagination
time:
$ref: '#/components/schemas/BitrixTime'
securitySchemes:
AccessToken:
type: apiKey
in: query
name: auth
description: OAuth 2.0 access_token or incoming webhook token
OAuth2:
type: oauth2
description: OAuth 2.0 authorization
flows:
authorizationCode:
authorizationUrl: https://oauth.bitrix.info/oauth/authorize/
tokenUrl: https://oauth.bitrix.info/oauth/token/
scopes:
crm: CRM — leads, deals, contacts, companies, smart processes
task: Tasks and projects
disk: Drive — files and folders
im: Chats and notifications
imbot: Chatbots
imopenlines: Open Lines — messenger connectors
telephony: Telephony
sale: E-Commerce — orders, shipments
catalog: Trade Catalog — products, prices
calendar: Calendar
bizproc: Business processes and robots
user: Users
department: Company structure
timeman: Time tracking
landing: Sites and landing pages
pay_system: Payment systems
cashbox: Online cash registers
delivery: Delivery services
documentgenerator: Document generator
lists: Universal lists
entity: Data storage
log: News feed
sonet_group: Workgroups and projects
mailservice: Mail services
messageservice: Message providers (SMS)
biconnector: BIconnector — BI analytics
ai_admin: CoPilot / AI
sign.b2e: Signature — e-document signing
vote: Polls and voting
booking: Online booking
userconsent: User consent agreements
userfieldconfig: Custom field settings
basic: Basic access
placement: Widget placements
rpa: Robots process automation
sonet: Social network
intranet: Intranet
socialnetwork: Social network
workgroups: Workgroups
salescenter: Sales center
main: Main module
imconnector: IM connector
user.userfield: User custom fields
user_basic: Basic user access
userfieldconfig, module scope: Custom field config
externalDocs:
description: Official Bitrix24 REST API Documentation
url: https://apidocs.bitrix24.com