Update the catalog section catalog.section.update
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.update modifies a section of the catalog.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
Identifier of the catalog section |
|
|
fields* |
Field values for updating the 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 |
|
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 |
|
active |
Indicator of the catalog section's activity:
|
|
description |
Description of the catalog section |
|
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 '{
"id": 32,
"fields": {
"iblockId": 14,
"name": "Children's Toys",
"description": "<H1>Children's Toys</H1> <p>Products for kids</p>",
"descriptionType": "html"
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.section.update
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"id": 32,
"fields": {
"iblockId": 14,
"name": "Children's Toys",
"description": "<H1>Children's Toys</H1> <p>Products for kids</p>",
"descriptionType": "html"
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/catalog.section.update
try
{
const response = await $b24.callMethod(
'catalog.section.update',
{
id: 32,
fields: {
iblockId: 14,
name: 'Children\'s Toys',
description: "<H1>Children's Toys</H1> <p>Products for kids</p>",
descriptionType: "html"
}
}
);
const result = response.getData().result;
console.log(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'catalog.section.update',
[
'id' => 32,
'fields' => [
'iblockId' => 14,
'name' => 'Children\'s Toys',
'description' => "<H1>Children's Toys</H1> <p>Products for kids</p>",
'descriptionType' => "html",
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating catalog section: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.section.update',
{
id: 32,
fields: {
iblockId: 14,
name: 'Children\'s Toys',
description: "<H1>Children's Toys</H1> <p>Products for kids</p>",
descriptionType: "html"
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.section.update',
[
'id' => 32,
'fields' => [
'iblockId' => 14,
'name' => 'Children\'s Toys',
'description' => '<H1>Children\'s Toys</H1> <p>Products for kids</p>',
'descriptionType' => 'html'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": {
"section": {
"active": "Y",
"code": "toys1",
"description": "<H1>Children's Toys</H1> <p>Products for kids</p>",
"descriptionType": "html",
"iblockId": 14,
"iblockSectionId": 13,
"id": 32,
"name": "Children's Toys",
"sort": 100,
"xmlId": "myXmlId"
}
},
"time": {
"start": 1712327086.69665,
"finish": 1712327086.95303,
"duration": 0.256376028060913,
"processing": 0.0112268924713135,
"date_start": "2024-04-05T16:24:46+02:00",
"date_finish": "2024-04-05T16:24:46+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
section |
Object with information about the updated catalog section |
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 400
{
"error":0,
"error_description":"Required fields: name"
}
|
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 edit |
|
|
Errors during update, for example, the identifier of the information block of the updated section does not match the identifier of the parent section |
|
|
No catalog section exists with such an identifier |
|
|
Violation of the uniqueness of the |
|
|
No information block exists with the specified |
|
|
Parameter |
|
|
Parameter |
|
|
Required fields of the |
|
|
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 |
Continue Learning
- Add a Section to the Catalog catalog.section.add
- Get Field Values of the Trade Catalog Section catalog.section.get
- Get a List of Sections in the Trade Catalog catalog.section.list
- Delete Catalog Section catalog.section.delete
- Get Fields of the Catalog Section catalog.section.getFields