Add a Section to the Catalog catalog.section.add
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.
Scope:
catalogWho can execute the method: administrator
The method catalog.section.add adds a section to the catalog.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Field values for creating a new catalog section |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
iblockId* |
Identifier of the information block. To obtain existing identifiers, use catalog.catalog.list |
|
iblockSectionId |
Identifier of the parent section. To obtain existing identifiers, use catalog.section.list. By default, the top level is selected |
|
name* |
Name of the catalog section |
|
xmlId |
External identifier. Can be used to synchronize the current catalog section with a similar position in an external system |
|
code |
Code of the catalog section. Must be unique |
|
sort |
Sorting. Default is 500 |
|
active |
Indicator of the catalog section's activity:
Default is |
|
description |
Description |
|
descriptionType |
Type of description. Available types: |
Code Examples
How to Use Examples in Documentation
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"fields": {
"name": "Children's Toys",
"iblockId": 14,
"iblockSectionId": 13,
"sort": "100",
"active": "Y",
"code": "toys",
"xmlId": "myXmlId",
"description": "Products for children - toys",
"descriptionType": "text"
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.section.add
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"fields": {
"name": "Children's Toys",
"iblockId": 14,
"iblockSectionId": 13,
"sort": "100",
"active": "Y",
"code": "toys",
"xmlId": "myXmlId",
"description": "Products for children - toys",
"descriptionType": "text"
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/catalog.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
// Shape of the payload returned in result (match the "response handling" section of the page)
type SectionAddResult = {
section: {
active: string
code: string
description: string
descriptionType: string
iblockId: number
iblockSectionId: number
id: number
name: string
sort: number
xmlId: string
}
}
try {
const response = await $b24.actions.v2.call.make<SectionAddResult>({
method: 'catalog.section.add',
params: {
fields: {
name: "Kids Toys",
iblockId: 14,
iblockSectionId: 13,
sort: '100',
active: 'Y',
code: 'toys',
xmlId: 'myXmlId',
description: "Products for children - toys",
descriptionType: "text",
},
},
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(result.section.id, result.section.name)
}
} 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 addCatalogSection() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.section.add',
params: {
fields: {
name: "Kids Toys",
iblockId: 14,
iblockSectionId: 13,
sort: '100',
active: 'Y',
code: 'toys',
xmlId: 'myXmlId',
description: "Products for children - toys",
descriptionType: "text",
},
},
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(result.section.id, result.section.name)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addCatalogSection)
</script>
try {
$response = $b24Service
->core
->call(
'catalog.section.add',
[
'fields' => [
'name' => 'Children\'s Toys',
'iblockId' => 14,
'iblockSectionId' => 13,
'sort' => '100',
'active' => 'Y',
'code' => 'toys',
'xmlId' => 'myXmlId',
'description' => "Products for children - toys",
'descriptionType' => "text",
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding catalog section: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.section.add',
{
fields: {
name: 'Children\'s Toys',
iblockId: 14,
iblockSectionId: 13,
sort: '100',
active: 'Y',
code: 'toys',
xmlId: 'myXmlId',
description: "Products for children - toys",
descriptionType: "text"
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.section.add',
[
'fields' => [
'name' => 'Children\'s Toys',
'iblockId' => 14,
'iblockSectionId' => 13,
'sort' => '100',
'active' => 'Y',
'code' => 'toys',
'xmlId' => 'myXmlId',
'description' => 'Products for children - toys',
'descriptionType' => 'text'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"section": {
"active": "Y",
"code": "toys",
"description": "Products for children - toys",
"descriptionType": "text",
"iblockId": 14,
"iblockSectionId": 13,
"id": 31,
"name": "Children's Toys",
"sort": 100,
"xmlId": "myXmlId"
}
},
"time": {
"start": 1716552521.40908,
"finish": 1716552521.69852,
"duration": 0.289434909820557,
"processing": 0.011207103729248,
"date_start": "2024-05-24T14:08:41+02:00",
"date_finish": "2024-05-24T14:08:41+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
section |
Object containing information about the added catalog section |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error":200040300040,
"error_description":"Access Denied"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
|
|
No access to editing |
|
|
Errors while adding, for example, the identifier of the information block of the created section does not match the identifier of the parent section |
|
|
Violation of the uniqueness of the |
|
|
Information block with the specified |
|
|
Required parameter |
|
|
Required fields not set |
|
|
Other errors (e.g., fatal errors) |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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 |