Additional Website Fields

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Additional website fields are passed in the ADDITIONAL_FIELDS array when calling the methods landing.site.add and landing.site.update.

Filled values can be retrieved using the method landing.site.getadditionalfields.

The method landing.site.getadditionalfields returns only non-empty website fields.

For recording, use the field codes in the ADDITIONAL_FIELDS array, for example:

{
            "ADDITIONAL_FIELDS": {
                "THEME_CODE": "1construction",
                "BACKGROUND_USE": "Y",
                "BACKGROUND_COLOR": "#f4f7fb"
            }
        }

What You Need to Know

  • The set of fields depends on the type of website, settings, and installed modules, so not all fields are available on every website.
  • For flag fields, the values Y and N are used.
  • If a field is empty, the method landing.site.getadditionalfields will not return it in the response.
  • The field BACKGROUND_PICTURE stores the file identifier when recorded, and the REST method usually returns the file URL in the response.

Theme and Fonts

Field
type

Description

THEME_CODE
string

The color theme code of the website. Available values are listed in the section Page Color Themes

THEME_USE
string

Enable a custom color palette for the website: Y or N

THEME_COLOR
string

Custom theme color in HEX format, for example #34bcf2

THEMEFONTS_USE
string

Enable custom font settings for the website: Y or N

THEMEFONTS_CODE
string

Font for the main text

THEMEFONTS_CODE_H
string

Font for headings

THEMEFONTS_SIZE
string

Base text size. Supported values are 0.92857, 1, 1.14286

THEMEFONTS_COLOR
string

Color of the main text in HEX format

THEMEFONTS_COLOR_H
string

Color of headings in HEX format

THEMEFONTS_LINE_HEIGHT
string

Line height. Supported values range from 0.7 to 2

THEMEFONTS_FONT_WEIGHT
string

Font weight of the main text. Supported values range from 100 to 900 in increments of 100

THEMEFONTS_FONT_WEIGHT_H
string

Font weight of headings. Supported values range from 100 to 900 in increments of 100

Bitrix24 Widget

Field
type

Description

B24BUTTON_USE
string

Enable the Bitrix24 widget: Y or N

B24BUTTON_CODE
string

Code or URL of the Bitrix24 widget script. It can be obtained in the widget settings in CRM

B24BUTTON_COLOR
string

Source of the widget color. Supported values are site, button, custom

B24BUTTON_COLOR_VALUE
string

Custom widget color in HEX format. Used if B24BUTTON_COLOR = custom

Back to Top Button

Field
type

Description

UP_SHOW
string

Show the back to top button: Y or N

Website Background

Field
type

Description

BACKGROUND_USE
string

Enable website background settings: Y or N

BACKGROUND_PICTURE
string | integer

Background image of the website. When recorded, the file identifier is passed; when read, the REST method usually returns the file URL

BACKGROUND_POSITION
string

Background display mode. Supported values are center, repeat, center_repeat_y, no_repeat

BACKGROUND_COLOR
string

Background color of the website in HEX format

Analytics

Analytics fields are not available on all plans. If analytics integrations are not available on your plan, enabling these fields will not activate counters.

Field
type

Description

GACOUNTER_USE
string

Enable Google Analytics: Y or N

GACOUNTER_COUNTER
string

Identifier of the old format counter UA-.... For the current GA4 counter, use the field GACOUNTER_COUNTER_GA4

GACOUNTER_COUNTER_GA4
string

Identifier of the Google Analytics 4 counter in the format G-...

GACOUNTER_SEND_CLICK
string

Send click events: Y or N

GACOUNTER_CLICK_TYPE
string

Where to get the signature for the click event. Supported values are href and text

GACOUNTER_SEND_SHOW
string

Send block show events: Y or N

GTM_USE
string

Enable Google Tag Manager: Y or N

GTM_COUNTER
string

Identifier of the Google Tag Manager container

Maps

Field
type

Description

GMAP_USE
string

Enable Google Maps API: Y or N

GMAP_CODE
string

Google Maps API key. Maps are connected only if GMAP_USE = Y and this field is filled

Website View

Field
type

Description

VIEW_USE
string

Enable special website view: Y or N

VIEW_TYPE
string

Type of view. Supported values are no, ltr, all, mobile, adaptive

Robots.txt

Field
type

Description

ROBOTS_USE
string

Enable custom robots.txt: Y or N

ROBOTS_CONTENT
string

Content of the custom robots.txt

Custom Code

The fields HEADBLOCK_* are not available on all plans.

Field
type

Description

HEADBLOCK_USE
string

Enable custom HTML or JavaScript in head: Y or N

HEADBLOCK_CODE
string

Arbitrary HTML or JavaScript added to the website's head

CSSBLOCK_USE
string

Enable custom CSS: Y or N

CSSBLOCK_CODE
string

Arbitrary CSS code for the website

CSSBLOCK_FILE
string

Link to an external CSS file

Continue Learning

Previous
Fields
Next
Add Site