Update Universal List lists.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:
listsWho can execute the method: a user with "Full access" permission for the required list
The lists.update method updates the universal list.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
IBLOCK_TYPE_ID* |
Information block type ID. Standard types:
In the on-premise version, you can also specify the ID of any existing custom information block type. The identifier can be obtained using the lists.get.iblock.type.id method |
|
IBLOCK_ID* |
Identifier of the information block. The identifier can be obtained using the lists.get method |
|
IBLOCK_CODE* |
Symbolic code of the information block. The code can be obtained using the lists.get method At least one of the parameters: |
|
SOCNET_GROUP_ID |
Group identifier. It is not necessary to specify this for changing list settings. Use this parameter if you want to move the list to another group. The identifier can be obtained using the socialnetwork.api.workgroup.list, sonet_group.get, and sonet_group.user.groups methods |
|
FIELDS* |
Array of list fields. |
|
MESSAGES |
Array of labels for list items and sections. Supported values:
|
|
RIGHTS |
Access permission settings for the list. An array in key-value format, where the key is the letter code of the user or department with the identifier, and the value is the letter code of the permission.
User categories:
You can obtain the user identifier using the user.get method, and the department identifier using the department.get method. Types of permissions:
Access permissions can only be assigned to users or departments that do not already have them. Existing permissions cannot be changed. |
FIELDS Parameter
Required parameters are marked with *
|
Name |
Description |
|
NAME* |
Name of the list |
|
DESCRIPTION |
Description of the list |
|
SORT |
Sorting |
|
PICTURE |
Picture. An object in the format |
|
BIZPROC |
Enabling business process support. Possible values:
|
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":109,"FIELDS":{"NAME":"Updated Task List","DESCRIPTION":"Updated description: list for managing daily tasks","SORT":600,"BIZPROC":"N"},"MESSAGES":{"ELEMENTS_NAME":"Items","ELEMENT_NAME":"Item","ELEMENT_ADD":"Create item","ELEMENT_EDIT":"Edit item","ELEMENT_DELETE":"Delete item","SECTIONS_NAME":"Categories","SECTION_NAME":"Category","SECTION_ADD":"Add category","SECTION_EDIT":"Edit category","SECTION_DELETE":"Delete category"},"RIGHTS":{"D15":"W"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/lists.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":109,"FIELDS":{"NAME":"Updated Task List","DESCRIPTION":"Updated description: list for managing daily tasks","SORT":600,"BIZPROC":"N"},"MESSAGES":{"ELEMENTS_NAME":"Items","ELEMENT_NAME":"Item","ELEMENT_ADD":"Create item","ELEMENT_EDIT":"Edit item","ELEMENT_DELETE":"Delete item","SECTIONS_NAME":"Categories","SECTION_NAME":"Category","SECTION_ADD":"Add category","SECTION_EDIT":"Edit category","SECTION_DELETE":"Delete category"},"RIGHTS":{"D15":"W"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/lists.update
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'lists.update',
params: {
IBLOCK_TYPE_ID: 'lists',
IBLOCK_ID: 109,
FIELDS: {
NAME: 'Updated task list',
DESCRIPTION: 'Updated description: list for managing daily tasks',
SORT: 600,
BIZPROC: 'N',
},
MESSAGES: {
ELEMENTS_NAME: 'Items',
ELEMENT_NAME: 'Item',
ELEMENT_ADD: 'Create item',
ELEMENT_EDIT: 'Edit item',
ELEMENT_DELETE: 'Delete item',
SECTIONS_NAME: 'Categories',
SECTION_NAME: 'Category',
SECTION_ADD: 'Add category',
SECTION_EDIT: 'Edit category',
SECTION_DELETE: 'Delete category',
},
RIGHTS: {
'D15': 'W',
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('List updated successfully:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function updateList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'lists.update',
params: {
IBLOCK_TYPE_ID: 'lists',
IBLOCK_ID: 109,
FIELDS: {
NAME: 'Updated task list',
DESCRIPTION: 'Updated description: list for managing daily tasks',
SORT: 600,
BIZPROC: 'N',
},
MESSAGES: {
ELEMENTS_NAME: 'Items',
ELEMENT_NAME: 'Item',
ELEMENT_ADD: 'Create item',
ELEMENT_EDIT: 'Edit item',
ELEMENT_DELETE: 'Delete item',
SECTIONS_NAME: 'Categories',
SECTION_NAME: 'Category',
SECTION_ADD: 'Add category',
SECTION_EDIT: 'Edit category',
SECTION_DELETE: 'Delete category',
},
RIGHTS: {
'D15': 'W',
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('List updated successfully:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"NAME": "Updated task list",
"DESCRIPTION": "Updated description: a list for managing daily tasks",
"SORT": 600,
"BIZPROC": "N",
}
messages = {
"ELEMENTS_NAME": "Items",
"ELEMENT_NAME": "Item",
"ELEMENT_ADD": "Create an item",
"ELEMENT_EDIT": "Edit the item",
"ELEMENT_DELETE": "Delete the item",
"SECTIONS_NAME": "Categories",
"SECTION_NAME": "Category",
"SECTION_ADD": "Add a category",
"SECTION_EDIT": "Edit the category",
"SECTION_DELETE": "Delete the category",
}
rights = {
"D15": "W",
}
try:
bitrix_response = client.lists.update(
iblock_type_id="lists",
iblock_id=109,
fields=fields,
messages=messages,
rights=rights,
).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}")
try {
$response = $b24Service
->core
->call(
'lists.update',
[
'IBLOCK_TYPE_ID' => 'lists',
'IBLOCK_ID' => 109,
'FIELDS' => [
'NAME' => 'Updated Task List',
'DESCRIPTION' => 'Updated description: list for managing daily tasks',
'SORT' => 600,
'BIZPROC' => 'N'
],
'MESSAGES' => [
'ELEMENTS_NAME' => 'Items',
'ELEMENT_NAME' => 'Item',
'ELEMENT_ADD' => 'Create item',
'ELEMENT_EDIT' => 'Edit item',
'ELEMENT_DELETE' => 'Delete item',
'SECTIONS_NAME' => 'Categories',
'SECTION_NAME' => 'Category',
'SECTION_ADD' => 'Add category',
'SECTION_EDIT' => 'Edit category',
'SECTION_DELETE' => 'Delete category'
],
'RIGHTS' => [
'D15' => 'W'
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating list: ' . $e->getMessage();
}
BX24.callMethod(
'lists.update',
{
IBLOCK_TYPE_ID: 'lists',
IBLOCK_ID: 109,
FIELDS: {
NAME: 'Updated Task List',
DESCRIPTION: 'Updated description: list for managing daily tasks',
SORT: 600,
BIZPROC: 'N'
},
MESSAGES: {
ELEMENTS_NAME: 'Items',
ELEMENT_NAME: 'Item',
ELEMENT_ADD: 'Create item',
ELEMENT_EDIT: 'Edit item',
ELEMENT_DELETE: 'Delete item',
SECTIONS_NAME: 'Categories',
SECTION_NAME: 'Category',
SECTION_ADD: 'Add category',
SECTION_EDIT: 'Edit category',
SECTION_DELETE: 'Delete category'
},
RIGHTS: {
'D15': 'W', // employees of department with ID=15 — modification
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'lists.update',
[
'IBLOCK_TYPE_ID' => 'lists',
'IBLOCK_ID' => 109,
'FIELDS' => [
'NAME' => 'Updated Task List',
'DESCRIPTION' => 'Updated description: list for managing daily tasks',
'SORT' => 600,
'BIZPROC' => 'N'
],
'MESSAGES' => [
'ELEMENTS_NAME' => 'Items',
'ELEMENT_NAME' => 'Item',
'ELEMENT_ADD' => 'Create item',
'ELEMENT_EDIT' => 'Edit item',
'ELEMENT_DELETE' => 'Delete item',
'SECTIONS_NAME' => 'Categories',
'SECTION_NAME' => 'Category',
'SECTION_ADD' => 'Add category',
'SECTION_EDIT' => 'Edit category',
'SECTION_DELETE' => 'Delete category'
],
'RIGHTS' => [
'D15' => 'W'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "lists.update", b24.Params{
"IBLOCK_TYPE_ID": "lists",
"IBLOCK_ID": 109,
"FIELDS": b24.Params{
"NAME": "Updated Task List",
"DESCRIPTION": "Updated description: list for managing daily tasks",
"SORT": 600,
"BIZPROC": "N",
},
"MESSAGES": b24.Params{
"ELEMENTS_NAME": "Items",
"ELEMENT_NAME": "Item",
"ELEMENT_ADD": "Create item",
"ELEMENT_EDIT": "Edit item",
"ELEMENT_DELETE": "Delete item",
"SECTIONS_NAME": "Categories",
"SECTION_NAME": "Category",
"SECTION_ADD": "Add category",
"SECTION_EDIT": "Edit category",
"SECTION_DELETE": "Delete category",
},
"RIGHTS": b24.Params{
"D15": "W",
},
})
if err != nil {
return fmt.Errorf("lists.update: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("done:", ok)
Response Handling
HTTP status: 200
{
"result": true,
"time": {
"start": 1764687690,
"finish": 1764687690.350469,
"duration": 0.35046911239624023,
"processing": 0,
"date_start": "2025-12-02T15:01:30+01:00",
"date_finish": "2025-12-02T15:01:30+01:00",
"operating_reset_at": 1764688290,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Returns |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error":"ERROR_IBLOCK_NOT_FOUND",
"error_description":"Iblock not found"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Required parameter |
Required parameter not provided |
|
|
Iblock not found |
List with such |
|
|
— |
Error updating the list |
|
|
Access denied |
Insufficient permissions to update the list |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |