Working with Pages: Overview of Methods

A page is always associated with a website. It can be created at the root of the site or within a folder. The methods landing.landing.* are used to:

• create, copy, and move pages,
• retrieve a list of pages and metadata,
• modify page parameters,
• publish and unpublish a page,
• restore and delete pages.

For example, you can create a promotional page within a store's website, publish it, and when the promotion ends, move it to another folder or unpublish it.

Quick Navigation: All Methods

How to Create a Website PageHow to Create a Website Page

1. Obtain the site ID using the methods landing.site.getList or landing.site.add.
2. If the page should reside in a folder, get the folder ID using the method landing.site.getFolders.
3. Create the page using the method landing.landing.add, landing.landing.addByTemplate, or landing.landing.copy.
4. To find the page and check its parameters, use landing.landing.getList, landing.landing.getadditionalfields, landing.landing.getpreview, and landing.landing.getpublicurl.
5. After configuration, publish the page using the method landing.landing.publication. If you need to hide the page, use landing.landing.unpublic.

Relationships with Other ObjectsRelationships with Other Objects

A page in Bitrix24 is linked to other objects. The site provides the overall context, the folder indicates the page's location in the structure, the view template defines the layout, blocks form the content, and special pages determine its role on the site.

Site. Each page belongs to a specific site. Therefore, when creating a page, you need to provide the SITE_ID, and to search for pages, specify a filter by site. The site ID can be obtained using the methods landing.site.getList or landing.site.add.

Folder. A page can be created within a folder. For this, the FOLDER_ID is provided. Later, the page can be moved to another folder or site using the method landing.landing.move. The list of site folders is returned by the method landing.site.getFolders.

View Template. When creating or updating a page, you can provide TPL_ID to immediately associate it with a view template. This helps set the desired structure and design. The list of templates is returned by landing.template.getlist, and the templates themselves are described in the section View Template.

Blocks. The methods in this section manage the page but do not edit the structure and content of the blocks. To work with blocks, use Page Blocks.

Special Pages. A regular page can be designated as a special page of the site, such as the main page, cart, or checkout page. For this, use the methods Special Pages.

Overview of MethodsOverview of Methods

Scope: landing

Who can execute the method: depending on the method

Creating and Modifying a PageCreating and Modifying a Page

Method	Description
landing.landing.add	Adds a page or folder
landing.landing.addByTemplate	Creates a page from a template
landing.landing.copy	Copies a page
landing.landing.update	Updates page parameters
landing.landing.move	Moves a page to another site or folder

Retrieving Data and NavigationRetrieving Data and Navigation

Method	Description
landing.landing.getList	Retrieves a list of pages
landing.landing.getadditionalfields	Retrieves additional fields of the page
landing.landing.getpreview	Retrieves the preview URL of the page
landing.landing.getpublicurl	Retrieves the public URL of the page
landing.landing.resolveIdByPublicUrl	Determines the page ID by public URL

PublicationPublication

Method	Description
landing.landing.publication	Publishes a page
landing.landing.unpublic	Unpublishes a page

Deletion and RestorationDeletion and Restoration

Method	Description
landing.landing.markDelete	Marks the page as deleted
landing.landing.markUnDelete	Restores the page from the trash
landing.landing.removeEntities	Deletes blocks and clears image file bindings of the page
landing.landing.delete	Deletes a page