For AI agents: markdown of this page — /docs-content-en/lists/sections/update.md documentation index — /llms.txt

Update a section

PATCH /v1/lists/:iblockId/sections/:sectionId

Updates the fields of an existing list section. Pass the fields to change inside the fields object using the Bitrix24 field format.

Parameters

Parameter	Type	Required	Description
`iblockId` (path)	string	yes	List ID or symbolic code. Use the `ID` or `CODE` field from List of lists
`sectionId` (path)	number	yes	Section ID, a positive integer from the `ID` field returned by List sections

Request body fields

Field	Type	Required	Description
`fields`	object	yes	Section fields to change. Keys are uppercase with underscores
`fields.NAME`	string	yes	Non-empty section name. Include it even when changing other fields. The current name is in the `NAME` field returned by Get section
`fields.CODE`	string	no	Section symbolic code
`fields.SORT`	number	no	Sort index
`fields.ACTIVE`	string	no	Whether the section is active: `Y` or `N`
`fields.IBLOCK_SECTION_ID`	number	no	Parent section ID from the `ID` field returned by List sections. `0` moves the section to the root of the list
`fields.XML_ID`	string	no	External section ID for data exchange
`fields.EXTERNAL_ID`	string	no	Alias for `XML_ID`
`fields.DESCRIPTION`	string	no	Section description. An empty string clears the description
`fields.DESCRIPTION_TYPE`	string	no	Description format: `text` or `html`
`fields.PICTURE`	array	no	Section image: an array `["filename.png", "BASE64_DATA"]`. The second element contains the file content encoded in Base64
`iblockTypeId`	string	no	Infoblock type. Values: `lists` — regular lists, default `lists_socnet` — workgroup lists `bitrix_processes` — service workflows `structure` — company-structure type (contains the built-in absence-calendar infoblock `absence`)
`socnetGroupId`	number	no	ID of the workgroup that contains the list. For a workgroup list, pass `iblockTypeId: "lists_socnet"` and the group ID from the `id` field returned by List workgroups. Omit it for a regular list

Pass the fields to change and fields.NAME. All other section settings keep their current values.

Examples

curl — personal key

Terminal

curl -X PATCH https://vibecode.bitrix24.com/v1/lists/23/sections/215 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fields": {
      "NAME": "North-Western region",
      "SORT": 200
    }
  }'

curl — OAuth application

Terminal

curl -X PATCH https://vibecode.bitrix24.com/v1/lists/23/sections/215 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "fields": {
      "NAME": "North-Western region",
      "SORT": 200
    }
  }'

JavaScript — personal key

javascript

const res = await fetch('https://vibecode.bitrix24.com/v1/lists/23/sections/215', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    fields: {
      NAME: 'North-Western region',
      SORT: 200,
    },
  }),
})

const { data } = await res.json()
console.log(data.updated)

JavaScript — OAuth application

javascript

const res = await fetch('https://vibecode.bitrix24.com/v1/lists/23/sections/215', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    fields: {
      NAME: 'North-Western region',
      SORT: 200,
    },
  }),
})

const { data } = await res.json()

Response fields

HTTP 200. To retrieve the updated fields, call Get section.

Field	Type	Description
`success`	boolean	Always `true` on success
`data`	object	Update result
`data.updated`	boolean	`true` on successful update

Response example

JSON

{
  "success": true,
  "data": {
    "updated": true
  }
}

Error response example

422 — the section name fields.NAME is missing: