Update Catalog Section v 3.0 catalog.section.update

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: catalog

Who can execute the method: a user with the "View product catalog" or "View catalog products" access permission, the "Edit product" permission, and permission to modify the section in the information block

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.update updates the fields of a trade catalog section and returns the section after the update.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Section identifier.

The identifier can be retrieved using the catalog.section.list method or when creating a section with the catalog.section.add method.

For a non-existent section, the method returns an access error

fields*
object

Object with the section fields to update. Pass only the fields being changed. Field description

An empty object {} returns the section unchanged

Parameter fields

Name `type`	Description
name `string`	Section name. An empty string causes a validation error
iblockSectionId `integer`	Identifier of the parent section in the same information block. The value `0` moves the section to the top level. A section cannot be moved into itself or into its own subsection. The identifier can be retrieved using the catalog.section.list method
active `string`	Section activity. Possible values: `Y` — the section is active `N` — the section is inactive Any value other than `Y` is saved as `N`
code `string`	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 `string`	External identifier of the section
sort `integer`	Sort index
description `string`	Section description
descriptionType `string`	Description format. Possible values: `text` — plain text `html` — HTML markup Other values are saved as `text`

The iblockId field cannot be changed: the section remains in the information block in which it was created.

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.update

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":387,"fields":{"name":"Bags and Backpacks","sort":200,"active":"N"}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.section.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":387,"fields":{"name":"Bags and Backpacks","sort":200,"active":"N"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.section.update

import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type SectionUpdateResult = {
          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<SectionUpdateResult>({
            method: 'catalog.section.update',
            params: {
              id: 387,
              fields: {
                name: 'Bags and Backpacks',
                sort: 200,
                active: 'N',
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Section updated:', result.item.id, result.item.name)
          }
        } 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 updateSection() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'catalog.section.update',
                params: {
                  id: 387,
                  fields: {
                    name: 'Bags and Backpacks',
                    sort: 200,
                    active: 'N',
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Section updated:', result.item.id, result.item.name)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateSection)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.section.update(
                bitrix_id=387,
                fields={
                    "name": "Bags and Backpacks",
                    "sort": 200,
                    "active": "N",
                },
            ).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.update',
                    [
                        'id' => 387,
                        'fields' => [
                            'name' => 'Bags and Backpacks',
                            'sort' => 200,
                            'active' => 'N',
                        ],
                    ]
                );
        
            $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.update',
            {
                id: 387,
                fields: {
                    name: 'Bags and Backpacks',
                    sort: 200,
                    active: 'N',
                },
            },
            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.update',
            [
                'id' => 387,
                'fields' => [
                    'name' => 'Bags and Backpacks',
                    'sort' => 200,
                    'active' => 'N',
                ],
            ]
        );
        
        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.update", b24.Params{
        	"id": 387,
        	"fields": b24.Params{
        		"name":   "Bags and Backpacks",
        		"sort":   200,
        		"active": "N",
        	},
        })
        if err != nil {
        	return fmt.Errorf("catalog.section.update: %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"`
        	Active string `json:"active"`
        	Sort   int    `json:"sort"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Name, item.Active)

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 387,
                    "iblockId": 25,
                    "name": "Bags and Backpacks",
                    "iblockSectionId": 385,
                    "active": "N",
                    "code": "bags",
                    "xmlId": "bags-001",
                    "sort": 200,
                    "description": "",
                    "descriptionType": "text"
                }
            },
            "time": {
                "start": 1792665575,
                "finish": 1792665576.002021,
                "duration": 1.002021074295044,
                "processing": 1,
                "date_start": "2026-10-22T13:39:35+02:00",
                "date_finish": "2026-10-22T13:39:36+02:00",
                "operating_reset_at": 1792666140,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Object with the response data
result.item `object`	All section fields after the update. Field description
time `time`	Information about the request execution time

Item Object

Name `type`	Description
id `integer`	Section identifier
iblockId `integer`	Identifier of the trade catalog information block
name `string`	Section name
iblockSectionId `integer`	Identifier of the parent section. `0` — a top-level section
active `string`	Section activity: `Y` — active, `N` — inactive
code `string`	Symbolic code of the section. An empty string if the code is not set
xmlId `string`	External identifier of the section. An empty string if the identifier is not set
sort `integer`	Sort index
description `string`	Section description. An empty string if the description is not set
descriptionType `string`	Description format: `text` or `html`

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "Field iblockId cannot be changed",
                        "field": "iblockId"
                    }
                ]
            }
        }

Name `type`	Description
error.code `string`	String error code. Use it to identify the type of exception
error.message `string`	Text description of the error
error.validation `array`	Array with error details. Present only in data validation errors `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Name of the field where the validation error occurred
error.validation[].message `string`	Description of the error related to the specified field

Possible Error Codes

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field	Error description	How to Fix
`-`	At least one of the required fields must be not empty: id, filter	Pass `id` — a positive number
`fields`	Required field `fields` is missing	Pass the `fields` object in the request body
`iblockId`	Field iblockId cannot be changed	Remove `iblockId` from `fields`. To place the section in a different information block, create a new section using the catalog.section.add method
`sort`	This request requires data type `int` in field `sort`	Pass a number
`-`	Section name is not specified.	Pass a non-empty `name` value
`-`	Cannot move the section inside itself	In `iblockSectionId`, specify a section that is not in the branch of the section being updated
`-`	Duplicate entry for key [code]	A section with this `code` already exists in the information block, but the user does not have access to it. Specify a different symbolic code

Filter Format Error

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION

Field	Error description	How to Fix
`filter`	Invalid filter `filter`	The method does not support `filter`. Pass the section `id`

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field	Error description	How to Fix
`-`	Unknown field `#FIELD#` found in entity `SectionDto`	Pass in `fields` only the fields from the Parameter fields table

Duplicate Symbolic Code Error

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYALREADYEXISTSEXCEPTION

Field	Error description	How to Fix
`-`	Record with ID `#ID#` already exists	Uniqueness of section symbolic codes is enabled in the information block, and section `#ID#` already uses this `code`. Specify a different symbolic code

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 section. The error is also returned for a non-existent section `id` or `iblockSectionId`

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

Was the article helpful?

Update Catalog Section

Get Field Values of Catalog Section

Update Catalog Section v 3.0 catalog.section.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Item ObjectItem Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Request Validation ErrorsRequest Validation Errors

Filter Format ErrorFilter Format Error

Unknown Field ErrorUnknown Field Error

Duplicate Symbolic Code ErrorDuplicate Symbolic Code Error

Access ErrorAccess Error

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Parameters

Parameter fields

Code Examples

Response Handling

Returned Data

Item Object

Error Handling

Possible Error Codes

Request Validation Errors

Filter Format Error

Unknown Field Error

Duplicate Symbolic Code Error

Access Error

Statuses and System Error Codes

Continue Learning