Websites and Stores: Overview of Methods
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
The methods in the landing group create and configure websites, stores, pages, and blocks. They manage publication, templates, access permissions, and embedding locations for applications.
The sequence of calls resembles working in a website editor: first, you create or select a site, then a page, add blocks, configure content, and publish the result.
Quick navigation: all methods
User documentation: Create and configure your Bitrix24 site
Structure of Websites and Stores
A website combines pages, folders, settings, access permissions, and publication. The type of website determines which pages, blocks, and settings are available in the landing methods.
A page belongs to a website and consists of blocks. Page methods create, copy, move, and publish the page, while block methods on the page add, hide, move, or delete blocks.
A block is a part of a page with an HTML structure, nodes, cards, attributes, and styles. Nodes store editable content, cards describe repeating elements of the block, and attributes and styles handle markup and design.
The block manifest shows which nodes, cards, attributes, and styles are available for modification via the API.
Changes to pages and blocks are saved in a draft. The publication method transfers changes to the public version of the page or website.
User Documentation
Getting Started
- Create a website using the landing.site.add method or retrieve an existing website using the landing.site.getList method.
- Create a page using the landing.landing.add method, select an existing one using the landing.landing.getList method, or create a page from a template using the landing.landing.addByTemplate method.
- Add a block to the page using the landing.landing.addblock method.
- Modify the block content using the landing.block.* methods.
- Publish the page using the landing.landing.publication method or the entire website using the landing.site.publication method.
Choosing Methods for Working with Blocks
There are two groups of methods for page blocks. The methods for working with blocks on the page manage the placement of blocks on a specific page: adding, copying, moving, hiding, deleting, and saving blocks to "My Blocks." The methods for the Block object modify the content of already placed blocks: nodes, cards, attributes, styles, content, and files.
|
Task |
What to use |
|
Add a block from the repository to the page |
|
|
Change the order, visibility, or state of a block on the page |
Methods for working with blocks on the page |
|
Change text, images, links, cards, or styles of a block |
Methods landing.block.* |
|
Get the code of a standard or custom block before adding |
|
|
Get the identifier of an already placed block |
landing.block.getList with |
Additional Scenarios
|
Task |
What to use |
|
Configure repeating parts of pages |
View templates and methods landing.template.* |
|
Add your blocks to the editor |
Custom blocks and methods landing.repo.* |
|
Add your templates to the website and page creation wizard |
Custom templates and methods landing.demos.* |
|
Configure access to websites and stores |
|
|
Embed an application into the interface of websites and pages |
Embedding Locations
Embedding locations allow you to add an application to the interface of websites and pages. The application can be opened from the website or page settings and from block editing actions.
Website or page settings. The embedding location LANDING_SETTINGS adds an application item to the settings menu of the website or page. The identifiers of the website and page are passed to the handler in PLACEMENT_OPTIONS.
Block actions. The embedding location LANDING_BLOCK_* adds an application item to the block action menu. The block identifier, block code, and page identifier are passed to the handler.
Knowledge Base. The binding of the Knowledge Base to a menu or group is described in the subsection Embedding the Knowledge Base. These bindings are managed by the landing.site.* methods because the Knowledge Base is presented as a separate website.
In the landing module, embedding locations are registered using the internal method landing.repo.bind, not placement.bind. You can remove the embedding location of the current application using the landing.repo.unbind method.
Types of Websites and Scope
The methods in the landing group work with different types of websites: regular websites, stores, service websites, Knowledge Bases, group Knowledge Bases, the main page, and vibes. For some types, you need to pass the scope parameter at the root of the request.
This parameter is not related to the access scope landing that you grant to the application or webhook. The rules for selecting the scope value and examples of requests are described in the article Working with Website Types and Scopes.
Key Identifiers
|
Identifier |
Where used |
How to obtain |
|
|
Page, folder, rights, template methods, website publication, and Knowledge Base bindings |
From the result of landing.site.add or landing.site.getList |
|
|
Page, block, page publication methods, and embedding location |
From the result of landing.landing.add, landing.landing.addByTemplate, landing.landing.copy, or landing.landing.getList |
|
|
Placing pages in folders and managing website structure |
From the result of landing.site.addFolder or landing.site.getFolders |
|
|
Modifying, moving, copying, hiding, and deleting a block on the page |
From the result of landing.landing.addblock or landing.block.getlist with |
|
|
Adding a standard or custom block to the page |
From landing.block.getrepository or after registering the block using the landing.repo.register method |
Overview of Methods
Scope:
landingWho can execute the method: depends on the method
Custom Blocks
|
Method |
Description |
|
Registers a custom block in the repository |
|
|
Checks the block content through a sanitizer |
|
|
Retrieves a list of custom blocks from the repository |
|
|
Removes a custom block from the repository by its code |
View Templates
|
Method |
Description |
|
Retrieves a list of view templates |
|
|
Retrieves a list of included areas for the website |
|
|
Sets included areas for the website |
|
|
Retrieves a list of included areas for the page |
|
|
Sets included areas for the page |
Custom Templates
|
Method |
Description |
|
Registers a template in the website and page creation wizard |
|
|
Retrieves a list of registered templates |
|
|
Retrieves a list of templates for creating websites |
|
|
Retrieves a list of templates for creating pages |
|
|
Removes a registered custom template |
Websites
|
Method |
Description |
|
Adds a website |
|
|
Adds a folder to the website |
|
|
Updates website parameters |
|
|
Updates folder parameters |
|
|
Retrieves a list of websites |
|
|
Retrieves website folders |
|
|
Returns the preview URL of the website |
|
|
Returns the public URL of the website |
|
|
Retrieves additional fields of the website |
|
|
Publishes the website and all its pages |
|
|
Publishes the website folder |
|
|
Unpublishes the website and all its pages |
|
|
Unpublishes the website folder |
|
|
Marks the website as deleted |
|
|
Marks the folder as deleted |
|
|
Restores the folder from the trash |
|
|
Restores the website from the trash |
|
|
Deletes the website |
|
|
Exports the website and its pages to an array |
Permissions
|
Method |
Description |
|
Enables or disables the role-based permission model |
|
|
Checks if the role-based permission model is enabled |
Extended Permission Model
|
Method |
Description |
|
Retrieves the current user's permissions for the website |
|
|
Sets access permissions for the website |
Role-Based Permission Model
|
Method |
Description |
|
Retrieves a list of roles for the current type of websites |
|
|
Returns the permissions of the role by websites |
|
|
Sets access codes for the role |
|
|
Sets the permissions of the role by websites |
Pages
|
Method |
Description |
|
Adds a page |
|
|
Creates a page from a template |
|
|
Copies a page |
|
|
Modifies page parameters |
|
|
Moves a page to another website or folder |
|
|
Retrieves a list of pages |
|
|
Retrieves additional fields of the page |
|
|
Returns the path to the page preview |
|
|
Returns the public URL of the page |
|
|
Returns the identifier of the page by public URL |
|
|
Publishes the page |
|
|
Unpublishes the page |
|
|
Marks the page as deleted |
|
|
Restores the page from deleted |
|
|
Removes blocks and images from the page |
|
|
Deletes the page |
Working with Blocks on the Page
|
Method |
Description |
|
Adds a new block to the page |
|
|
Copies a block from one page to another |
|
|
Deletes a block from the page |
|
|
Moves the block down one position |
|
|
Saves the block to "My Blocks" |
|
|
Hides the block on the page |
|
|
Marks the block as deleted without physically removing it |
|
|
Restores the block from deleted |
|
|
Moves the block from one page to another |
|
|
Shows the block on the page |
|
|
Removes the block from "My Blocks" |
|
|
Moves the block up one position |
Special Pages
|
Method |
Description |
|
Deletes the page binding as special |
|
|
Deletes all special pages of the website |
|
|
Retrieves the address of the special page of the website |
|
|
Retrieves a list of special pages |
|
|
Assigns a special page for the website |
Blocks
|
Method |
Description |
|
Retrieves a list of blocks on the page |
|
|
Retrieves a block by its identifier |
|
|
Retrieves the content of the block |
|
|
Retrieves the manifest of the block already placed on the page |
|
|
Modifies the content of the block's nodes |
|
|
Modifies the attributes of the block's nodes |
|
|
Modifies the styles of the block |
|
|
Updates the content of the block placed on the page with arbitrary content |
|
|
Changes the tag name of the node |
|
|
Changes the symbolic code of the block's anchor |
|
|
Uploads a file and binds it to the block |
|
|
Clones a card of the block |
|
|
Adds a card to the block with modified content |
|
|
Removes a card from the block |
|
|
Massively modifies the cards of the block |
|
|
Retrieves a list of blocks from the repository |
|
|
Retrieves the manifest of the block from the repository |
|
|
Retrieves the content of the block from the repository before adding it to the page |
Embedding Locations
|
Method or Embedding Location |
Description |
|
Adds an application item to the settings menu of the website or page |
|
|
Adds an application item to the block editing actions |
|
|
Removes the embedding location of the current application |
Embedding the Knowledge Base
|
Method |
Description |
|
Binds the Knowledge Base to a Social Network group |
|
|
Binds the Knowledge Base to a menu |
|
|
Retrieves the bindings of Knowledge Bases to groups |
|
|
Retrieves the bindings of Knowledge Bases to menus |
|
|
Unbinds the Knowledge Base from a Social Network group |
|
|
Unbinds the Knowledge Base from a menu |