Object Page: Overview of Methods

Methods help manage the page and its associated actions. With these methods, you can:

• modify the page,
• manage its blocks,
• assign a special role to the page on the site.

For example, you can create a promotional page, fill it with blocks, and publish it. Once the promotion ends, you can unpublish the page, move it to another folder, or delete it.

The fields of the page are described in a separate article Page Fields.

Quick navigation: all methods

How to Work with the PageHow to Work with the Page

Working with the page starts with the site. First, obtain the site ID using the method landing.site.getList. If the page needs to be placed in a folder, additionally get the folder ID using the method landing.site.getFolders.

After that, choose a method to create the page:

• landing.landing.add if you need a new page,
• landing.landing.addByTemplate if you need a page with a predefined structure,
• landing.landing.copy if you want to base it on an existing page.

Once the page is created, you can configure its parameters using the methods landing.landing.update and landing.landing.move.

The completed page can be published or hidden. To publish, use landing.landing.publication, and to unpublish the page, use landing.landing.unpublic.

When to Pass ScopeWhen to Pass Scope

The scope parameter indicates the type of site or page in which the method should operate. This is an internal parameter for landing pages and is not related to the REST scope landing in the method name.

If scope is not specified, the method will only work in the standard context. For non-public types, such as knowledge, group, and vibe, this is insufficient. In such cases, the site or page may not be found, even though they exist.

The scope parameter is necessary in methods that search for a page, change its visibility, or work with content. For example, in landing.landing.getList, landing.landing.publication, landing.landing.unpublic, and in the methods of the section Working with Page Blocks.

For instance, if the page belongs to the knowledge base, the call should include scope=knowledge. This way, the method will search for and modify the page within the knowledge base. Without this parameter, the page may not be found. The rules for selecting values and their relation to site types are described in the article Working with Site Types and Scopes.

Relationships with Other ObjectsRelationships with Other Objects

A page in Bitrix24 is always connected with other objects. The site sets the overall context, blocks provide content, and special pages define the page's purpose on the site.

Site. Each page belongs to a specific site. Therefore, when creating a page, you need to pass SITE_ID. The site ID can be obtained using the methods landing.site.getList or landing.site.add.

Folder. A page can be placed in a folder to organize the site structure. For this, FOLDER_ID is used. The list of site folders is returned by landing.site.getFolders, and moving a page to another folder or site is done using landing.landing.move.

View Template. When creating or updating a page, you can pass TPL_ID to immediately set its design and structure. The list of templates is returned by landing.template.getlist. More details about them can be found in the section View Template.

Blocks. The content of the page consists of blocks. The methods in this section allow you to manage blocks on the page: add, delete, and change their order. To modify the content of a block, use the methods in the section Working with Page Blocks.

Special Pages. A page can be designated as a special page of the site. For example, it can be made the main page or a service page for a specific scenario. For this, use the methods from the section Special Pages.

Overview of MethodsOverview of Methods

Scope: landing

Who can execute the method: depending on the method

Working with PagesWorking with Pages

Method	Description
landing.landing.add	Adds a page
landing.landing.addByTemplate	Creates a page from a template
landing.landing.copy	Copies a page
landing.landing.update	Modifies page parameters
landing.landing.move	Moves a page to another site or folder
landing.landing.getList	Retrieves a list of pages
landing.landing.getadditionalfields	Retrieves additional fields of the page
landing.landing.getpreview	Returns the path to the page preview
landing.landing.getpublicurl	Returns the public URL of the page
landing.landing.resolveIdByPublicUrl	Returns the page ID by public URL
landing.landing.publication	Makes the page available in the current context
landing.landing.unpublic	Hides the page in the current context
landing.landing.markDelete	Marks the page as deleted
landing.landing.markUnDelete	Restores the page from deleted
landing.landing.removeEntities	Deletes blocks and images from the page
landing.landing.delete	Deletes the page

Working with BlocksWorking with Blocks

Method	Description
landing.landing.addblock	Adds a new block to the page
landing.landing.copyblock	Copies a block from one page to another
landing.landing.deleteblock	Deletes a block from the page
landing.landing.downblock	Moves a block down one position
landing.landing.favoriteBlock	Saves a block to "My Blocks"
landing.landing.hideblock	Hides a block on the page
landing.landing.markdeletedblock	Marks a block as deleted without physically removing it
landing.landing.markundeletedblock	Restores a block from deleted
landing.landing.moveblock	Moves a block from one page to another
landing.landing.showblock	Displays a block on the page
landing.landing.unFavoriteBlock	Removes a block from "My Blocks"
landing.landing.upblock	Moves a block up one position

Special PagesSpecial Pages

Method	Description
landing.syspage.deleteForLanding	Removes the page's binding as a special one
landing.syspage.deleteForSite	Deletes all special pages of the site
landing.syspage.getSpecialPage	Retrieves the address of the special page of the site
landing.syspage.get	Retrieves a list of special pages
landing.syspage.set	Assigns a special page for the site