Entity Fields Site
We are still updating this page
Some data may be missing here — we will fill it in shortly.
|
Field |
Description |
Read |
Write |
|
ID |
Site identifier. Created automatically and unique within the database. |
Yes |
No |
|
CODE* |
Unique symbolic code of the site. Does not appear in the cloud B24. |
Yes |
Yes |
|
ACTIVE |
Site activity: Y / N. |
Yes |
No |
|
TYPE* |
Type of site. (PAGE – regular site, STORE – store). Type of site. Be sure to familiarize yourself with the concept of scopes. |
Yes |
Yes |
|
DELETED |
Flag for deleted page: Y / N. |
Yes |
Yes |
|
TITLE* |
Title of the site. |
Yes |
Yes |
|
XML_ID |
External key for developer needs. Not used by the service. |
Yes |
Yes |
|
DESCRIPTION |
Arbitrary description of the site. Displayed in the list of sites. |
Yes |
Yes |
|
DOMAIN_ID |
If the field is provided and it is empty, a random domain in the bitrix24.site zone will be created. Otherwise, a new specified account in the bitrix24.site zone will be registered if it is not occupied. By default, a random domain is created. |
No |
Yes |
|
DOMAIN_NAME |
Domain of the site. |
Yes |
Yes |
|
LANDING_ID_INDEX |
ID of the page designated as the main page of the site. |
Yes |
Yes |
|
LANDING_ID_404 |
ID of the page designated as the site's 404 error page. |
Yes |
Yes |
|
TPL_ID |
Identifier of the view template. |
Yes |
Yes |
|
LANG |
This field is relevant only for cloud Bitrix24, containing the language identifier that will be used for the site (some language phrases will change, for example, in the order form). |
Yes |
Yes |
|
CREATED_BY_ID |
Identifier of the user who created it. |
Yes |
No |
|
MODIFIED_BY_ID |
Identifier of the user who modified it. |
Yes |
No |
|
DATE_CREATE |
Creation date. |
Yes |
No |
|
DATE_MODIFY |
Modification date. |
Yes |
No |
|
PUBLIC_URL |
Public URL of the site. |
Yes |
No |
|
PREVIEW_PICTURE |
Preview image of the site (its main page). |
Yes |
No |
Required parameters are marked with *
Entities marked as deleted do not appear in any requests. The system does not see them. You can only access such entities through REST by explicitly specifying DELETED=Y in the filter.