Create a universal list lists.add

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

The lists.add method creates a 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
IBLOCK_CODE* `string`	Symbolic code of the information block
SOCNET_GROUP_ID `integer`	Group identifier. Use this parameter if you want to add the list to a group. The identifier can be obtained using the methods socialnetwork.api.workgroup.list, sonet_group.get, and sonet_group.user.groups
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 method user.get, and the department identifier using the method department.get. 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 If the parameter is not provided, the authorized user who called the method is assigned full access.

Parameter FIELDS

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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_CODE":"my_custom_list","FIELDS":{"NAME":"My new list","DESCRIPTION":"List for tracking tasks in the project","SORT":500,"BIZPROC":"Y"},"MESSAGES":{"ELEMENTS_NAME":"Tasks","ELEMENT_NAME":"Task","ELEMENT_ADD":"Add task","ELEMENT_EDIT":"Edit task","ELEMENT_DELETE":"Delete task","SECTIONS_NAME":"Sections","SECTION_NAME":"Section","SECTION_ADD":"Add section","SECTION_EDIT":"Edit section","SECTION_DELETE":"Delete section"},"RIGHTS":{"U1271":"X"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/lists.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_CODE":"my_custom_list","FIELDS":{"NAME":"My new list","DESCRIPTION":"List for tracking tasks in the project","SORT":500,"BIZPROC":"Y"},"MESSAGES":{"ELEMENTS_NAME":"Tasks","ELEMENT_NAME":"Task","ELEMENT_ADD":"Add task","ELEMENT_EDIT":"Edit task","ELEMENT_DELETE":"Delete task","SECTIONS_NAME":"Sections","SECTION_NAME":"Section","SECTION_ADD":"Add section","SECTION_EDIT":"Edit section","SECTION_DELETE":"Delete section"},"RIGHTS":{"U1271":"X"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/lists.add

try {
            const response = await $b24.callMethod(
              'lists.add',
              {
                  IBLOCK_TYPE_ID: 'lists',
                  IBLOCK_CODE: 'my_custom_list',
                  FIELDS: {
                    NAME: 'My new list',
                    DESCRIPTION: 'List for tracking tasks in the project',
                    SORT: 500,
                    BIZPROC: 'Y'
                  },
                  MESSAGES: {
                    ELEMENTS_NAME: 'Tasks',
                    ELEMENT_NAME: 'Task',
                    ELEMENT_ADD: 'Add task',
                    ELEMENT_EDIT: 'Edit task',
                    ELEMENT_DELETE: 'Delete task',
                    SECTIONS_NAME: 'Sections',
                    SECTION_NAME: 'Section',
                    SECTION_ADD: 'Add section',
                    SECTION_EDIT: 'Edit section',
                    SECTION_DELETE: 'Delete section'
                  },
                  RIGHTS: {
                    'U1271': 'X'
                  }
              }
          );
        
            const result = response.getData().result;
            console.log('Created list with ID:', result);
            processResult(result);
        } catch (error) {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'lists.add',
                    [
                        'IBLOCK_TYPE_ID' => 'lists',
                        'IBLOCK_CODE' => 'my_custom_list',
                        'FIELDS' => [
                            'NAME' => 'My new list',
                            'DESCRIPTION' => 'List for tracking tasks in the project',
                            'SORT' => 500,
                            'BIZPROC' => 'Y'
                        ],
                        'MESSAGES' => [
                            'ELEMENTS_NAME' => 'Tasks',
                            'ELEMENT_NAME' => 'Task',
                            'ELEMENT_ADD' => 'Add task',
                            'ELEMENT_EDIT' => 'Edit task',
                            'ELEMENT_DELETE' => 'Delete task',
                            'SECTIONS_NAME' => 'Sections',
                            'SECTION_NAME' => 'Section',
                            'SECTION_ADD' => 'Add section',
                            'SECTION_EDIT' => 'Edit section',
                            'SECTION_DELETE' => 'Delete section'
                        ],
                        'RIGHTS' => [
                            'U1271' => 'X'
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding list: ' . $e->getMessage();
        }

BX24.callMethod(
          'lists.add',
          {
             IBLOCK_TYPE_ID: 'lists',
             IBLOCK_CODE: 'my_custom_list',
             FIELDS: {
               NAME: 'My new list',
               DESCRIPTION: 'List for tracking tasks in the project',
               SORT: 500,
               BIZPROC: 'Y'
             },
             MESSAGES: {
               ELEMENTS_NAME: 'Tasks',
               ELEMENT_NAME: 'Task',
               ELEMENT_ADD: 'Add task',
               ELEMENT_EDIT: 'Edit task',
               ELEMENT_DELETE: 'Delete task',
               SECTIONS_NAME: 'Sections',
               SECTION_NAME: 'Section',
               SECTION_ADD: 'Add section',
               SECTION_EDIT: 'Edit section',
               SECTION_DELETE: 'Delete section'
             },
             RIGHTS: {
               'U1271': 'X',     // user with ID=1271 — full access
             }
           },
             function(result) {
                if (result.error()) {
                   console.error(result.error());
                } else {
                   console.log(result.data());
             }
           }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'lists.add',
            [
                'IBLOCK_TYPE_ID' => 'lists',
                'IBLOCK_CODE' => 'my_custom_list',
                'FIELDS' => [
                    'NAME' => 'My new list',
                    'DESCRIPTION' => 'List for tracking tasks in the project',
                    'SORT' => 500,
                    'BIZPROC' => 'Y'
                ],
                'MESSAGES' => [
                    'ELEMENTS_NAME' => 'Tasks',
                    'ELEMENT_NAME' => 'Task',
                    'ELEMENT_ADD' => 'Add task',
                    'ELEMENT_EDIT' => 'Edit task',
                    'ELEMENT_DELETE' => 'Delete task',
                    'SECTIONS_NAME' => 'Sections',
                    'SECTION_NAME' => 'Section',
                    'SECTION_ADD' => 'Add section',
                    'SECTION_EDIT' => 'Edit section',
                    'SECTION_DELETE' => 'Delete section'
                ],
                'RIGHTS' => [
                    'U1271' => 'X'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": 109,
            "time": {
               "start": 1764675143,
               "finish": 1764675143.174578,
               "duration": 0.17457795143127441,
               "processing": 0,
               "date_start": "2025-12-02T14:32:23+01:00",
               "date_finish": "2025-12-02T14:32:23+01:00",
               "operating_reset_at": 1764675743,
               "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `integer`	Identifier of the created information block
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error":"ERROR_IBLOCK_ALREADY_EXISTS",
            "error_description":"Iblock already exists"
        }

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 is missing
`ERROR_IBLOCK_ALREADY_EXISTS`	Iblock already exists	A list with this `IBLOCK_CODE` already exists
`ERROR_ADD_IBLOCK`	—	Error adding the list
`ACCESS_DENIED`	Access denied	The method was called by a non-administrator

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

Overview of Methods

Update List

Create a universal list lists.add

Method ParametersMethod Parameters

Parameter FIELDSParameter FIELDS

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning