Additional Page Fields
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.
Additional page fields are passed in the ADDITIONAL_FIELDS array when calling the methods landing.landing.add and landing.landing.update.
Filled values can be retrieved using the method landing.landing.getadditionalfields.
The method landing.landing.getadditionalfields returns only non-empty page fields.
For writing, use the field codes in the ADDITIONAL_FIELDS array, for example:
{
"ADDITIONAL_FIELDS": {
"METAROBOTS_INDEX": "Y",
"METAMAIN_USE": "Y",
"METAMAIN_TITLE": "Page Title"
}
}
What You Need to Know
- The set of fields depends on the type of site, settings, and installed modules, so not all fields are available on every site.
- System fields may appear in the response of the reading method, but they are not set manually.
- For flag fields, use values
YandN. - If a field is empty, the method
landing.landing.getadditionalfieldswill not return it in the response. - The fields
METAOG_IMAGE,BACKGROUND_PICTURE, andFAVICON_PICTUREare related to files. - The fields
SETTINGS_*pertain to catalog and trading section settings.
Theme and Fonts
|
Field |
Description |
|
THEME_CODE |
The color theme code of the page. Available values are listed in the section Page Color Themes |
|
THEME_USE |
Enable a custom color palette for the page: |
|
THEME_COLOR |
Custom theme color in HEX format, for example |
|
THEMEFONTS_USE |
Enable custom font settings for the page: |
|
THEMEFONTS_CODE |
Font for the main text |
|
THEMEFONTS_CODE_H |
Font for headings |
|
THEMEFONTS_SIZE |
Base text size. Supported values are |
|
THEMEFONTS_COLOR |
Color of the main text in HEX format |
|
THEMEFONTS_COLOR_H |
Color of headings in HEX format |
|
THEMEFONTS_LINE_HEIGHT |
Line height. Supported values range from |
|
THEMEFONTS_FONT_WEIGHT |
Font weight of the main text. Supported values range from |
|
THEMEFONTS_FONT_WEIGHT_H |
Font weight of headings. Supported values range from |
|
FONTS_CODE |
System field with HTML for connecting fonts. May be present in the response of the reading method |
Social Networks and SEO
|
Field |
Description |
|
METAOG_TITLE |
Title for Open Graph, tag |
|
METAOG_DESCRIPTION |
Description for Open Graph, tag |
|
METAOG_IMAGE |
Image for Open Graph, tag |
|
METAMAIN_USE |
Enable custom meta tags for the page: |
|
METAMAIN_TITLE |
Value of the |
|
METAMAIN_DESCRIPTION |
Value of the |
|
METAMAIN_KEYWORDS |
Value of the |
|
METAKEYWORDS_KEYWORDS |
Value of the |
|
METAROBOTS_INDEX |
Allow indexing of the page: |
|
METAGOOGLEVERIFICATION_USE |
Enable Google Search Console verification meta tag: |
|
METAGOOGLEVERIFICATION_META |
Full Google Search Console verification tag |
|
ROBOTS_USE |
Enable custom |
|
ROBOTS_CONTENT |
Content of the custom |
Background, Animation, Icon, and Page View
|
Field |
Description |
|
BACKGROUND_USE |
Enable background settings for the page: |
|
BACKGROUND_PICTURE |
Background image of the page. Usually, the reading method returns the file URL |
|
BACKGROUND_POSITION |
Background display mode. Supported values are |
|
BACKGROUND_COLOR |
Background color of the page in HEX format |
|
FAVICON_PICTURE |
Favicon image. Usually, the reading method returns the file URL |
|
VIEW_USE |
Enable special page view: |
|
VIEW_TYPE |
Type of view. Supported values are |
|
PADDING_TOPBOTTOM |
Vertical outer margins of the page. Supported values are |
|
PADDING_LEFTRIGHT |
Horizontal layout constraints. Supported values are |
|
LAYOUT_BREAKPOINT |
Breakpoint for adaptive view. Supported values are |
|
TRANSITION_COLOR |
Background color for the page appearance animation |
|
UP_SHOW |
Show back-to-top button: |
Analytics and Pixels
|
Field |
Description |
|
GACOUNTER_USE |
Enable Google Analytics: |
|
GACOUNTER_COUNTER |
Identifier of the Universal Analytics counter |
|
GACOUNTER_COUNTER_GA4 |
Identifier of the Google Analytics 4 counter |
|
GACOUNTER_SEND_CLICK |
Send click events: |
|
GACOUNTER_CLICK_TYPE |
Where to get the signature for the click event. Supported values are |
|
GACOUNTER_SEND_SHOW |
Send block show events: |
|
GTM_USE |
Enable Google Tag Manager: |
|
GTM_COUNTER |
Identifier of the Google Tag Manager container |
|
PIXELFB_USE |
Enable Facebook pixel: |
|
PIXELFB_COUNTER |
Identifier of the Facebook pixel |
|
PIXELVK_USE |
Enable VK pixel: |
|
PIXELVK_COUNTER |
Identifier of the VK pixel |
Custom Code and Styles
|
Field |
Description |
|
HEADBLOCK_USE |
Enable custom HTML or JavaScript in |
|
HEADBLOCK_CODE |
Arbitrary HTML or JavaScript added to the |
|
CSSBLOCK_USE |
Enable custom CSS: |
|
CSSBLOCK_CODE |
Arbitrary CSS code for the page |
|
CSSBLOCK_FILE |
Link to an external CSS file |
|
CUSTOMCSS_CSS_CODE |
Additional custom CSS code from a separate hook |
|
CUSTOMCSS_CSS_URL |
Link to an external CSS file from a separate hook |
Maps
|
Field |
Description |
|
GMAP_USE |
Enable Google Maps API: |
|
GMAP_CODE |
Google Maps API key |
Bitrix24 Widget
|
Field |
Description |
|
B24BUTTON_USE |
Enable Bitrix24 widget: |
|
B24BUTTON_CODE |
Code or URL of the widget script |
|
B24BUTTON_COLOR |
Source of the widget color. Supported values are |
|
B24BUTTON_COLOR_VALUE |
Custom widget color in HEX format |
|
B24BUTTON_HELP |
System field with a link to help |
Cookies and System Banners
|
Field |
Description |
|
COOKIES_USE |
Show cookies banner: |
|
COOKIES_AGREEMENT_ID |
Use agreement in the cookies banner: |
|
COOKIES_COLOR_BG |
Background color of the cookies banner in HEX format |
|
COOKIES_COLOR_TEXT |
Text color of the cookies banner in HEX format |
|
COOKIES_POSITION |
Position of the cookies banner. Supported values are |
|
COOKIES_MODE |
Mode of the cookies banner. Supported values are |
|
COPYRIGHT_SHOW |
Show copyright or system footer: |
|
Identifier of the text variant for the footer |
Performance
|
Field |
Description |
|
SPEED_ASSETS |
System field with a list of resources for optimization |
|
SPEED_USE_LAZY |
Use lazy load: |
|
SPEED_USE_WEBPACK |
Use webpack resource build mode: |
Catalog and Trading Section Settings
These fields are generated by the SETTINGS hook. They depend on the installed catalog modules, currencies, and trading functionality. Some fields from this group may not be available on a specific site.
|
Field |
Description |
|
Identifier of the catalog information block |
|
|
Identifier of the catalog section |
|
|
SETTINGS_HIDE_NOT_AVAILABLE |
Mode for hiding unavailable products |
|
SETTINGS_HIDE_NOT_AVAILABLE_OFFERS |
Hide unavailable product variants: |
|
SETTINGS_PRODUCT_SUBSCRIPTION |
Enable product subscription: |
|
SETTINGS_USE_PRODUCT_QUANTITY |
Enable product stock accounting: |
|
SETTINGS_DISPLAY_COMPARE |
Show product comparison: |
|
SETTINGS_PRICE_CODE |
Array of price type codes |
|
SETTINGS_CURRENCY_ID |
Currency code |
|
SETTINGS_PRICE_VAT_INCLUDE |
Include VAT in price: |
|
SETTINGS_SHOW_OLD_PRICE |
Show old price: |
|
SETTINGS_SHOW_DISCOUNT_PERCENT |
Show discount percentage: |
|
SETTINGS_USE_PRICE_COUNT |
Enable price ranges: |
|
SETTINGS_SHOW_PRICE_COUNT |
Number of prices to display |
|
SETTINGS_USE_ENHANCED_ECOMMERCE |
Enable enhanced e-commerce: |
|
SETTINGS_DATA_LAYER_NAME |
Name of the data layer for analytics |
|
SETTINGS_BRAND_PROPERTY |
Brand property code |
|
SETTINGS_CART_POSITION |
Position of the cart. Supported values are |
|
SETTINGS_AGREEMENT_USE |
Enable agreements: |
|
Identifier of the agreement |
|
|
SETTINGS_AGREEMENTS |
Array of agreements in the format |
Continue Learning
- landing.landing.add
- landing.landing.update
- Page Color Themes
- landing.landing.getadditionalfields
- landing.syspage.set