Update the catalog section catalog.section.update

Scope: catalog

Who can execute the method: administrator

The method catalog.section.update modifies a section of the catalog.

Method Parameters

Required parameters are marked with *

Name `type`	Description
id* `catalog_section.id`	Identifier of the catalog section
fields* `object`	Field values for updating the catalog section

Parameter fields

Required parameters are marked with *

Name `type`	Description
iblockId* `catalog_catalog.id`	Identifier of the information block. To obtain existing identifiers, use catalog.catalog.list
iblockSectionId `catalog_section.id`	Identifier of the parent section. To obtain existing identifiers, use catalog.section.list
name* `string`	Name of the catalog section
xmlId `string`	External identifier. Can be used to synchronize the current catalog section with a similar position in an external system
code `string`	Code of the catalog section. Must be unique
sort `integer`	Sorting
active `string`	Indicator of the catalog section's activity: `Y` — active `N` — inactive
description `string`	Description of the catalog section
descriptionType `string`	Type of description. Available types: `text`, `html`

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

-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 `type`	Description
result `object`	Root element of the response
section `catalog_section`	Object with information about the updated catalog section
time `time`	Information about the execution time of the request

Error Handling

HTTP status: 400

{
            "error":0,
            "error_description":"Required fields: name"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `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
`200040300040`	No access to edit
`200700300010`	Errors during update, for example, the identifier of the information block of the updated section does not match the identifier of the parent section
`200700300030`	No catalog section exists with such an identifier
`200700300040`	Violation of the uniqueness of the `code` field
`200700300050`	No information block exists with the specified `iblockId`
`100`	Parameter `id` not specified
`100`	Parameter `fields` not specified or empty
`0`	Required fields of the `fields` structure not provided
`0`	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 Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Add Catalog Section

Get Field Values of Catalog Section

Update the catalog section catalog.section.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning