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. The fields to change are passed inside the fields object in the Bitrix24 form.

Parameters

Parameter Type Required Description
iblockId (path) string yes Numeric IBLOCK_ID or the list's symbolic code
sectionId (path) number yes Numeric section ID. List of sections: GET /v1/lists/:iblockId/sections

Request body fields

Field Type Required Description
fields object yes Section fields to change, in the Bitrix24 form. Keys inside are uppercase with underscores, for example NAME, SORT, DESCRIPTION
iblockTypeId string no Infoblock type. Values:
lists — regular lists, default
lists_socnet — workgroup lists
bitrix_processes — service workflows

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

Field Type Description
success boolean Always true on success
data.updated boolean true on successful update

Response example

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

Error response example

400 — a required parameter is missing:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FIELDS",
    "message": "`fields` is required and must be an object."
  }
}

Errors

HTTP Code Description
400 INVALID_PARAMS sectionId is not a positive integer
400 MISSING_REQUIRED_FIELDS The fields object is missing
400 INVALID_IBLOCK_TYPE iblockTypeId is not one of lists, lists_socnet, bitrix_processes
403 BITRIX_ACCESS_DENIED The section or list does not exist, or the key has no access to it
409 LISTS_MODULE_NOT_ENABLED The Lists module is not enabled on the Bitrix24 portal
403 WRITE_BLOCKED_READONLY_KEY The key operates in read-only mode
403 SCOPE_DENIED The key is missing the lists scope
401 TOKEN_MISSING The key has no access tokens configured

Full list of common API errors — Errors.

See also