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

Who 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
type

Description

IBLOCK_TYPE_ID*
string

Identifier of the information block type. Possible values:

  • lists — list information block type
  • bitrix_processes — processes information block type
  • lists_socnet — group lists information block type

The identifier can be obtained using the lists.get.iblock.type.id method

IBLOCK_ID*
integer

Identifier of the information block.

The identifier can be obtained using the lists.get method

IBLOCK_CODE*
string

Symbolic code of the information block.

The code can be obtained using the lists.get method

At least one of the parameters: IBLOCK_ID or IBLOCK_CODE must be specified.

SOCNET_GROUP_ID
integer

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

Array of list fields.

Detailed description

MESSAGES
array

Array of labels for list items and sections. Supported values:

  • ELEMENTS_NAME — name of the items
  • ELEMENT_NAME — name of the item
  • ELEMENT_ADD — add item
  • ELEMENT_EDIT — edit item
  • ELEMENT_DELETE — delete item
  • SECTIONS_NAME — name of the sections
  • SECTION_NAME — name of the section
  • SECTION_ADD — add section
  • SECTION_EDIT — edit section
  • SECTION_DELETE — delete section

RIGHTS
array

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.

RIGHTS: {
            'U1': 'X', // User with ID=1 — full access
            'D5': 'D'  // Employees of the department with ID=5 — access denied
        }
        

User categories:

  • U — user
  • * — all users
  • D — all department employees
  • DR — all department employees with subdivisions

You can obtain the user identifier using the user.get method, and the department identifier using the department.get method.

Types of permissions:

  • D — no access
  • R — read
  • E — add
  • S — view in panel
  • T — add in panel
  • U — modify with restrictions
  • W — modify
  • X — full access

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
type

Description

NAME*
string

Name of the list

DESCRIPTION
string

Description of the list

SORT
integer

Sorting

PICTURE
array

Picture. An object in the format {fileData: [value1, value2]}, where value1 is the name of the picture file with the extension, and value2 is the picture in base64 format

BIZPROC
string

Enabling business process support. Possible values:

  • Y — yes
  • N — no

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
        
try {
          const response = await $b24.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'
                  }
              }
          );
        
          const result = response.getData().result;
          console.log('Updated list with ID:', result);
          processResult(result);
        } catch (error) {
          console.error('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>';
        

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
type

Description

result
boolean

Returns true if the list was successfully updated

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error":"ERROR_IBLOCK_NOT_FOUND",
            "error_description":"Iblock not found"
        }
        

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

Value

ERROR_REQUIRED_PARAMETERS_MISSING

Required parameter X is missing

Required parameter not provided

ERROR_IBLOCK_NOT_FOUND

Iblock not found

List with such IBLOCK_ID or IBLOCK_CODE not found

ERROR_UPDATE_IBLOCK

Error updating the list

ACCESS_DENIED

Access denied

Insufficient permissions to update the list

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 permitted for calls 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 HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only

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 "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