Add a Storage Section entity.section.add

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

Scope: entity

Who can execute the method: a user with W (write) or X (manage) access permission on the data storage.

The entity.section.add method adds a section to the application's data storage.

The method works only in the context of the application.

Method Parameters

Required parameters are marked with *

Name
type

Description

ENTITY*
string

Identifier of the application's data storage. Use the value specified when creating the storage.

You can obtain the identifier using the entity.get method.

NAME*
string

Name of the section.

SECTION
integer

Identifier of the parent section.

ACTIVE
string

Section activity flag:

  • Y — section is active
  • N — section is inactive

SORT
integer

Section sorting index.

CODE
string

Symbolic code of the section.

DESCRIPTION
string

Description of the section.

PICTURE
file

Section image. File format — as described in How to upload files.

DETAIL_PICTURE
file

Detailed image of the section. File format — as described in How to upload files.

UF_
any

Custom fields of the section UF_*.

Passed as separate parameters in the format "UF_CODE": value, for example: "UF_COLOR": "#ff6600"

Code Examples

How to Use Examples in Documentation

Example of adding a section to the dish storage:

  • ENTITY — storage identifier
  • NAME — section name
  • SECTION — parent section 671
  • ACTIVE, SORT, CODE, DESCRIPTION — main parameters
  • PICTURE, DETAIL_PICTURE — files in the format described in How to upload files
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ENTITY":"dish","NAME":"Test Section","SECTION":671,"ACTIVE":"Y","SORT":500,"CODE":"test-section","DESCRIPTION":"Description of the test section","PICTURE":["section.jpg","**base64_section_image**"],"DETAIL_PICTURE":["section-detail.jpg","**base64_section_detail_image**"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/entity.section.add
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<number>({
            method: 'entity.section.add',
            params: {
              ENTITY: 'dish',
              NAME: 'Test section',
              SECTION: 671,
              ACTIVE: 'Y',
              SORT: 500,
              CODE: 'testovyy-razdel',
              DESCRIPTION: 'Test section description',
              PICTURE: ['section.jpg', '**base64_section_image**'],
              DETAIL_PICTURE: ['section-detail.jpg', '**base64_section_detail_image**'],
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Created section ID:', result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function addEntitySection() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'entity.section.add',
                params: {
                  ENTITY: 'dish',
                  NAME: 'Test section',
                  SECTION: 671,
                  ACTIVE: 'Y',
                  SORT: 500,
                  CODE: 'testovyy-razdel',
                  DESCRIPTION: 'Test section description',
                  PICTURE: ['section.jpg', '**base64_section_image**'],
                  DETAIL_PICTURE: ['section-detail.jpg', '**base64_section_detail_image**'],
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Created section ID:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addEntitySection)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.entity.section.add(
                entity="dish",
                name="Test section",
                section=671,
                active=True,
                sort=500,
                code="testovyy-razdel",
                description="Test section description",
                picture=(
                    "section.jpg",
                    "**base64_section_image**",
                ),
                detail_picture=(
                    "section-detail.jpg",
                    "**base64_section_detail_image**",
                ),
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'entity.section.add',
                    [
                        'ENTITY' => 'dish',
                        'NAME' => 'Test Section',
                        'SECTION' => 671,
                        'ACTIVE' => 'Y',
                        'SORT' => 500,
                        'CODE' => 'test-section',
                        'DESCRIPTION' => 'Description of the test section',
                        'PICTURE' => ['section.jpg', '**base64_section_image**'],
                        'DETAIL_PICTURE' => ['section-detail.jpg', '**base64_section_detail_image**'],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding entity section: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'entity.section.add',
            {
                ENTITY: 'dish',
                NAME: 'Test Section',
                SECTION: 671,
                ACTIVE: 'Y',
                SORT: 500,
                CODE: 'test-section',
                DESCRIPTION: 'Description of the test section',
                PICTURE: ['section.jpg', '**base64_section_image**'],
                DETAIL_PICTURE: ['section-detail.jpg', '**base64_section_detail_image**'],
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'entity.section.add',
            [
                'ENTITY' => 'dish',
                'NAME' => 'Test Section',
                'SECTION' => 671,
                'ACTIVE' => 'Y',
                'SORT' => 500,
                'CODE' => 'test-section',
                'DESCRIPTION' => 'Description of the test section',
                'PICTURE' => ['section.jpg', '**base64_section_image**'],
                'DETAIL_PICTURE' => ['section-detail.jpg', '**base64_section_detail_image**'],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "entity.section.add", b24.Params{
        	"ENTITY":         "dish",
        	"NAME":           "Test Section",
        	"SECTION":        671,
        	"ACTIVE":         "Y",
        	"SORT":           500,
        	"CODE":           "testovyy-razdel",
        	"DESCRIPTION":    "Description of the test section",
        	"PICTURE":        []string{"section.jpg", "**base64_section_image**"},
        	"DETAIL_PICTURE": []string{"section-detail.jpg", "**base64_section_detail_image**"},
        })
        if err != nil {
        	return fmt.Errorf("entity.section.add: %w", err)
        }
        
        var newID b24.ID
        if err := json.Unmarshal(res.Result, &newID); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("id:", newID)
        

Response Handling

HTTP Status: 200

{
            "result": 673,
            "time": {
                "start": 1774275397,
                "finish": 1774275397.576672,
                "duration": 0.5766720771789551,
                "processing": 0,
                "date_start": "2026-03-23T17:16:37+01:00",
                "date_finish": "2026-03-23T17:16:37+01:00",
                "operating_reset_at": 1774275997,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
integer

Identifier of the created section.

time
time

Information about the request execution time.

Error Handling

HTTP Status: 400

{
            "error": "ERROR_ENTITY_NOT_FOUND",
            "error_description": "Entity not found"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Value

ERROR_ARGUMENT

Argument 'ENTITY' is null or empty

Parameter ENTITY is not provided or is empty after cleaning.

ERROR_ARGUMENT

Entity code is too long. Max length is N characters.

The value of ENTITY is too long.

ERROR_ENTITY_NOT_FOUND

Entity not found

Storage with the provided ENTITY was not found.

ACCESS_DENIED

Access denied!

Insufficient rights to create a section.

ERROR_CORE

Internal error adding entity section. Try adding again.

Internal error while creating the section.

ERROR_CORE

Invalid parent section!

An invalid SECTION was provided.

ERROR_CORE

The section block code does not match the parent section block code!

The parent section belongs to another storage.

ERROR_CORE

Invalid file type

A file of unsupported type was provided in PICTURE or DETAIL_PICTURE.

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning