Add Catalog Section v 3.0 catalog.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:
catalogWho can execute the method: a user with the "View product catalog" or "View catalog products" access permission, the "Create product" permission, and permission to modify information block sections
The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The method catalog.section.add creates a trade catalog section and returns its fields.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Object with the fields of the new section. Field description |
Parameter fields
|
Name |
Description |
|
iblockId* |
Identifier of the trade catalog information block in which the section is created. The information block of a section cannot be changed after creation. The identifier can be retrieved using the catalog.catalog.list method |
|
name* |
Section name. An empty string causes a validation error |
|
iblockSectionId |
Identifier of the parent section. The section must be in the same information block. The identifier can be retrieved using the catalog.section.list method. Default: |
|
active |
Section activity. Possible values:
Any value other than Default: |
|
code |
Symbolic code of the section. If uniqueness of section symbolic codes is enabled in the information block settings, the code must be unique within the information block |
|
xmlId |
External identifier of the section, for example, for synchronization with an accounting system |
|
sort |
Sort index. Default: |
|
description |
Section description |
|
descriptionType |
Description format. Possible values:
Other values are saved as Default: |
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/catalog.section.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"iblockId":25,"name":"Bags","iblockSectionId":385,"code":"bags","xmlId":"bags-001","sort":100}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.section.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"iblockId":25,"name":"Bags","iblockSectionId":385,"code":"bags","xmlId":"bags-001","sort":100},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.section.add
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type SectionAddResult = {
item: {
id: number
iblockId: number
name: string
iblockSectionId: number
active: 'Y' | 'N'
code: string
xmlId: string
sort: number
description: string
descriptionType: 'text' | 'html'
}
}
try {
const response = await $b24.actions.v3.call.make<SectionAddResult>({
method: 'catalog.section.add',
params: {
fields: {
iblockId: 25,
name: 'Bags',
iblockSectionId: 385,
code: 'bags',
xmlId: 'bags-001',
sort: 100,
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Section created:', result.item.id)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addSection() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'catalog.section.add',
params: {
fields: {
iblockId: 25,
name: 'Bags',
iblockSectionId: 385,
code: 'bags',
xmlId: 'bags-001',
sort: 100,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Section created:', result.item.id)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addSection)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.section.add(
fields={
"iblockId": 25,
"name": "Bags",
"iblockSectionId": 385,
"code": "bags",
"xmlId": "bags-001",
"sort": 100,
},
).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}")
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
try {
$response = $b24Service
->core
->call(
'catalog.section.add',
[
'fields' => [
'iblockId' => 25,
'name' => 'Bags',
'iblockSectionId' => 385,
'code' => 'bags',
'xmlId' => 'bags-001',
'sort' => 100,
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
BX24.callMethod(
'catalog.section.add',
{
fields: {
iblockId: 25,
name: 'Bags',
iblockSectionId: 385,
code: 'bags',
xmlId: 'bags-001',
sort: 100,
},
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
require_once('crest.php');
$result = CRest::call(
'catalog.section.add',
[
'fields' => [
'iblockId' => 25,
'name' => 'Bags',
'iblockSectionId' => 385,
'code' => 'bags',
'xmlId' => 'bags-001',
'sort' => 100,
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "catalog.section.add", b24.Params{
"fields": b24.Params{
"iblockId": 25,
"name": "Bags",
"iblockSectionId": 385,
"code": "bags",
"xmlId": "bags-001",
"sort": 100,
},
})
if err != nil {
return fmt.Errorf("catalog.section.add: %w", err)
}
// The method wraps the response in an object with the "item" key.
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("the response has no item key")
}
var item struct {
ID int `json:"id"`
Name string `json:"name"`
IblockSectionID int `json:"iblockSectionId"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.Name)
Response Handling
HTTP status: 200
{
"result": {
"item": {
"id": 387,
"iblockId": 25,
"name": "Bags",
"iblockSectionId": 385,
"active": "Y",
"code": "bags",
"xmlId": "bags-001",
"sort": 100,
"description": "",
"descriptionType": "text"
}
},
"time": {
"start": 1792665527,
"finish": 1792665527.384296,
"duration": 0.3842959403991699,
"processing": 0,
"date_start": "2026-10-22T13:38:47+02:00",
"date_finish": "2026-10-22T13:38:47+02:00",
"operating_reset_at": 1792666080,
"operating": 0.12565898895263672
}
}
Returned Data
|
Name |
Description |
|
result |
Object with the response data |
|
result.item |
Fields of the created section. Field description |
|
time |
Information about the request execution time |
Item Object
|
Name |
Description |
|
id |
Section identifier |
|
iblockId |
Identifier of the trade catalog information block |
|
name |
Section name |
|
iblockSectionId |
Identifier of the parent section. |
|
active |
Section activity: |
|
code |
Symbolic code of the section. An empty string if the code is not set |
|
xmlId |
External identifier of the section. An empty string if the identifier is not set |
|
sort |
Sort index |
|
description |
Section description. An empty string if the description is not set |
|
descriptionType |
Description format: |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
"message": "Error validating object.",
"validation": [
{
"message": "Required field \"name\" is empty.",
"field": "name"
}
]
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Section Field Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass |
|
|
Required field |
Pass |
|
|
Field |
Remove |
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass the |
|
|
This request requires data type |
Pass a number |
|
|
Section name is not specified. |
Pass a non-empty |
|
|
Duplicate entry for key [code] |
A section with this |
Unknown Field Error
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
Pass in |
Duplicate Symbolic Code Error
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYALREADYEXISTSEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Record with ID |
Uniqueness of section symbolic codes is enabled in the information block, and section |
Access Error
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
HTTP status: 403
|
Field |
Error description |
How to Fix |
|
|
Access denied |
Check the user's permissions for the catalog and the information block sections. The error is also returned for a non-existent |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |