Update the Universal List Field lists.field.update

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: lists

Who can execute the method: a user with "Full access" permission for the required list

The method lists.field.update updates a list field.

The field type cannot be changed. Please provide the type that was specified when the field was created.

Method Parameters

Required parameters are marked with *

Name `type`	Description
IBLOCK_TYPE_ID* `string`	Information block type ID. Standard types: `lists` — universal lists `bitrix_processes` — processes `lists_socnet` — group lists In the on-premise version, you can also specify the ID of any existing custom information block type. `IBLOCK_ID` or `IBLOCK_CODE` must point to an information block of this type. Access to the operation is determined by the user's standard permissions for the information block, section, or element 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.
FIELDS* `array`	Array of parameters. Detailed description
FIELD_ID* `string`	Identifier of the field. For a custom field, it appears as `PROPERTY_PropertyId`. For a system field, it is its symbolic code. The identifier can be obtained using the lists.field.get method.

Parameter FIELDS

Required parameters are marked with *

Name `type`	Description
NAME* `string`	Field name
TYPE* `string`	Field type. The type cannot be changed; please provide the one that was specified when the field was created. Custom fields: `S` — String `N` — Number `L` — List `F` — File `G` — Section binding `E` — Element binding `S:Date` — Date `S:DateTime` — Date/Time `S:HTML` — HTML/text `E:EList` — Element binding in list form `N:Sequence` — Counter `S:ECrm` — CRM element binding `S:Money` — Money `S:DiskFile` — File (Disk) `S:employee` — Employee binding System fields: `SORT` — Sorting `ACTIVE_FROM` — Start of activity `ACTIVE_TO` — End of activity `PREVIEW_PICTURE` — Preview image `PREVIEW_TEXT` — Preview text `DETAIL_PICTURE` — Detailed image `DETAIL_TEXT` — Detailed text `DATE_CREATE` — Creation date `CREATED_BY` — Created by `TIMESTAMP_X` — Modification date `MODIFIED_BY` — Modified by Values in the fields Creation date, Modification date, Created by, and Modified by are filled automatically.
IS_REQUIRED `string`	Field required flag. Possible values: `Y` — yes `N` — no
MULTIPLE `string`	Field multiplicity flag. Possible values: `Y` — yes `N` — no System fields cannot be multiple.
SORT `integer`	Sorting
DEFAULT_VALUE	Default value. If the `ADD_READ_ONLY_FIELD` setting is enabled in `SETTINGS`, this parameter becomes required.
LIST `array`	Values for the List type field. An array in the format `{'ID': { 'VALUE': 'Value_1', 'SORT': 10, 'DEF': 'N' }}`, where `'ID'` — identifier, `VALUE` — displayed text, `SORT` — sorting order, `DEF` — default value indicator. The identifier can be obtained using the lists.field.get method.
LIST_TEXT_VALUES `string`	An alternative way to specify values for the List type field. A string where values are separated by the newline character `\n`. When updating a List type field, you can use either `LIST`, `LIST_TEXT_VALUES`, or both parameters together. In this case, the values from the string will be added to those already in the array.
LIST_DEF `array`	Default value for the List type field. The array accepts the identifier from `LIST`.
CODE `string`	Symbolic code of the field. Required for custom fields. Not used for system fields.
SETTINGS `array`	Display and behavior settings. Supported values: `SHOW_ADD_FORM` — show in the add form `SHOW_EDIT_FORM` — show in the edit form `ADD_READ_ONLY_FIELD` — read-only (add form) `EDIT_READ_ONLY_FIELD` — read-only (edit form) `SHOW_FIELD_PREVIEW` — show the field when generating a link to the list item To enable a setting, use `Y`, to disable it — `N`.
USER_TYPE_SETTINGS `array`	Array of settings for custom fields. The structure depends on the field type: HTML/text — array in the format `{'height': 200}`, where `height` — height of the editor window Element binding in list form — array in the format `{'size': 1, 'width': 0, 'group': 'N', 'multiple': 'N'}`, where `size` — height of the list, `width` — width limit (`0` - no limit), `group` — grouping by sections, `multiple` — display as a multiple choice list Counter — array in the format `{'write': 'N', 'VALUE': 1}`, where `write` — permission to change values, `VALUE` — current counter value CRM element binding — array in the format `{'VISIBLE': 'N', 'LEAD': 'N', 'CONTACT': 'N', 'COMPANY': 'N', 'DEAL': 'N'}`, where `VISIBLE` — visibility in the CRM card, `LEAD` — lead, `CONTACT` — contact, `COMPANY` — company, `DEAL` — deal.
ROW_COUNT `integer`	Height of the field.
COL_COUNT `integer`	Width of the field.
LINK_IBLOCK_ID `integer`	Identifier of the related list. Required for types Binding to sections, Binding to elements, and Binding to elements in list form.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":"123","FIELD_ID":"PROPERTY_1151","FIELDS":{"NAME":"Task Status","SORT":"50","IS_REQUIRED":"N","MULTIPLE":"N","TYPE":"L","LIST":{"1669":{"VALUE":"Planning","SORT":10},"1671":{"VALUE":"In Progress","SORT":20},"1673":{"VALUE":"Testing","SORT":30},"1675":{"VALUE":"Completed","SORT":40},"1677":{"VALUE":"Deferred","SORT":50}},"LIST_TEXT_VALUES":"Archive","LIST_DEF":["1671"],"SETTINGS":{"SHOW_ADD_FORM":"Y","SHOW_EDIT_FORM":"Y","ADD_READ_ONLY_FIELD":"N","EDIT_READ_ONLY_FIELD":"Y","SHOW_FIELD_PREVIEW":"N"}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/lists.field.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":"123","FIELD_ID":"PROPERTY_1151","FIELDS":{"NAME":"Task Status","SORT":"50","IS_REQUIRED":"N","MULTIPLE":"N","TYPE":"L","LIST":{"1669":{"VALUE":"Planning","SORT":10},"1671":{"VALUE":"In Progress","SORT":20},"1673":{"VALUE":"Testing","SORT":30},"1675":{"VALUE":"Completed","SORT":40},"1677":{"VALUE":"Deferred","SORT":50}},"LIST_TEXT_VALUES":"Archive","LIST_DEF":["1671"],"SETTINGS":{"SHOW_ADD_FORM":"Y","SHOW_EDIT_FORM":"Y","ADD_READ_ONLY_FIELD":"N","EDIT_READ_ONLY_FIELD":"Y","SHOW_FIELD_PREVIEW":"N"}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/lists.field.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.field.update',
            params: {
              IBLOCK_TYPE_ID: 'lists',
              IBLOCK_ID: '123',
              FIELD_ID: 'PROPERTY_1151',
              FIELDS: {
                NAME: 'Task status',
                SORT: '50',
                IS_REQUIRED: 'N',
                MULTIPLE: 'N',
                TYPE: 'L',
                LIST: {
                  '1669': { VALUE: 'Planning', SORT: 10 },
                  '1671': { VALUE: 'In progress', SORT: 20 },
                  '1673': { VALUE: 'Testing', SORT: 30 },
                  '1675': { VALUE: 'Done', SORT: 40 },
                  '1677': { VALUE: 'On hold', SORT: 50 },
                },
                LIST_TEXT_VALUES: 'Archive',
                LIST_DEF: ['1671'],
                SETTINGS: {
                  SHOW_ADD_FORM: 'Y',
                  SHOW_EDIT_FORM: 'Y',
                  ADD_READ_ONLY_FIELD: 'N',
                  EDIT_READ_ONLY_FIELD: 'Y',
                  SHOW_FIELD_PREVIEW: 'N',
                },
              },
            },
            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('Field 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 updateListField() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'lists.field.update',
                params: {
                  IBLOCK_TYPE_ID: 'lists',
                  IBLOCK_ID: '123',
                  FIELD_ID: 'PROPERTY_1151',
                  FIELDS: {
                    NAME: 'Task status',
                    SORT: '50',
                    IS_REQUIRED: 'N',
                    MULTIPLE: 'N',
                    TYPE: 'L',
                    LIST: {
                      '1669': { VALUE: 'Planning', SORT: 10 },
                      '1671': { VALUE: 'In progress', SORT: 20 },
                      '1673': { VALUE: 'Testing', SORT: 30 },
                      '1675': { VALUE: 'Done', SORT: 40 },
                      '1677': { VALUE: 'On hold', SORT: 50 },
                    },
                    LIST_TEXT_VALUES: 'Archive',
                    LIST_DEF: ['1671'],
                    SETTINGS: {
                      SHOW_ADD_FORM: 'Y',
                      SHOW_EDIT_FORM: 'Y',
                      ADD_READ_ONLY_FIELD: 'N',
                      EDIT_READ_ONLY_FIELD: 'Y',
                      SHOW_FIELD_PREVIEW: 'N',
                    },
                  },
                },
                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('Field updated successfully:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateListField)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        fields = {
            "NAME": "Task status",
            "SORT": "50",
            "IS_REQUIRED": "N",
            "MULTIPLE": "N",
            "TYPE": "L",
            "LIST": {
                "1669": {
                    "VALUE": "Planning",
                    "SORT": 10,
                },
                "1671": {
                    "VALUE": "In active work",
                    "SORT": 20,
                },
                "1673": {
                    "VALUE": "Testing",
                    "SORT": 30,
                },
                "1675": {
                    "VALUE": "Completed",
                    "SORT": 40,
                },
                "1677": {
                    "VALUE": "Postponed",
                    "SORT": 50,
                },
            },
            "LIST_TEXT_VALUES": "Archive",
            "LIST_DEF": [
                "1671",
            ],
            "SETTINGS": {
                "SHOW_ADD_FORM": "Y",
                "SHOW_EDIT_FORM": "Y",
                "ADD_READ_ONLY_FIELD": "N",
                "EDIT_READ_ONLY_FIELD": "Y",
                "SHOW_FIELD_PREVIEW": "N",
            },
        }
        
        try:
            bitrix_response = client.lists.field.update(
                iblock_type_id="lists",
                iblock_id=123,
                field_id="PROPERTY_1151",
                fields=fields,
            ).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.field.update',
                    [
                        'IBLOCK_TYPE_ID' => 'lists',
                        'IBLOCK_ID' => '123',
                        'FIELD_ID' => 'PROPERTY_1151',
                        'FIELDS' => [
                            'NAME' => 'Task Status',
                            'SORT' => '50',
                            'IS_REQUIRED' => 'N',
                            'MULTIPLE' => 'N',
                            'TYPE' => 'L',
                            'LIST' => [
                                '1669' => ['VALUE' => 'Planning', 'SORT' => 10],
                                '1671' => ['VALUE' => 'In Progress', 'SORT' => 20],
                                '1673' => ['VALUE' => 'Testing', 'SORT' => 30],
                                '1675' => ['VALUE' => 'Completed', 'SORT' => 40],
                                '1677' => ['VALUE' => 'Deferred', 'SORT' => 50]
                            ],
                            'LIST_TEXT_VALUES' => 'Archive',
                            'LIST_DEF' => ['1671'],
                            'SETTINGS' => [
                                'SHOW_ADD_FORM' => 'Y',
                                'SHOW_EDIT_FORM' => 'Y',
                                'ADD_READ_ONLY_FIELD' => 'N',
                                'EDIT_READ_ONLY_FIELD' => 'Y',
                                'SHOW_FIELD_PREVIEW' => 'N'
                            ]
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating field: ' . $e->getMessage();
        }

BX24.callMethod(
            'lists.field.update',
            {
                'IBLOCK_TYPE_ID': 'lists',
                'IBLOCK_ID': '123',
                'FIELD_ID': 'PROPERTY_1151',
                'FIELDS': {
                    'NAME': 'Task Status',
                    'SORT': '50',
                    'IS_REQUIRED': 'N',
                    'MULTIPLE': 'N',
                    'TYPE': 'L', // The type cannot be changed; use the one that exists
                    'LIST': {
                        '1669': { 'VALUE': 'Planning', 'SORT': 10 },
                        '1671': { 'VALUE': 'In Progress', 'SORT': 20 },
                        '1673': { 'VALUE': 'Testing', 'SORT': 30 },
                        '1675': { 'VALUE': 'Completed', 'SORT': 40 },
                        '1677': { 'VALUE': 'Deferred', 'SORT': 50 }
                    },
                    'LIST_TEXT_VALUES': 'Archive',
                    'LIST_DEF': ['1671'],
                    'SETTINGS': {
                        'SHOW_ADD_FORM': 'Y',
                        'SHOW_EDIT_FORM': 'Y',
                        'ADD_READ_ONLY_FIELD': 'N',
                        'EDIT_READ_ONLY_FIELD': 'Y',
                        'SHOW_FIELD_PREVIEW': 'N'
                    }
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'lists.field.update',
            [
                'IBLOCK_TYPE_ID' => 'lists',
                'IBLOCK_ID' => '123',
                'FIELD_ID' => 'PROPERTY_1151',
                'FIELDS' => [
                    'NAME' => 'Task Status',
                    'SORT' => '50',
                    'IS_REQUIRED' => 'N',
                    'MULTIPLE' => 'N',
                    'TYPE' => 'L',
                    'LIST' => [
                        '1669' => ['VALUE' => 'Planning', 'SORT' => 10],
                        '1671' => ['VALUE' => 'In Progress', 'SORT' => 20],
                        '1673' => ['VALUE' => 'Testing', 'SORT' => 30],
                        '1675' => ['VALUE' => 'Completed', 'SORT' => 40],
                        '1677' => ['VALUE' => 'Deferred', 'SORT' => 50]
                    ],
                    'LIST_TEXT_VALUES' => 'Archive',
                    'LIST_DEF' => ['1671'],
                    'SETTINGS' => [
                        'SHOW_ADD_FORM' => 'Y',
                        'SHOW_EDIT_FORM' => 'Y',
                        'ADD_READ_ONLY_FIELD' => 'N',
                        'EDIT_READ_ONLY_FIELD' => 'Y',
                        'SHOW_FIELD_PREVIEW' => 'N'
                    ]
                ]
            ]
        );
        
        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.field.update", b24.Params{
        	"IBLOCK_TYPE_ID": "lists",
        	"IBLOCK_ID":      "123",
        	"FIELD_ID":       "PROPERTY_1151",
        	"FIELDS": b24.Params{
        		"NAME":        "Task Status",
        		"SORT":        "50",
        		"IS_REQUIRED": "N",
        		"MULTIPLE":    "N",
        		"TYPE":        "L",
        		"LIST": b24.Params{
        			"1669": b24.Params{
        				"VALUE": "Planning",
        				"SORT":  10,
        			},
        			"1671": b24.Params{
        				"VALUE": "In Progress",
        				"SORT":  20,
        			},
        			"1673": b24.Params{
        				"VALUE": "Testing",
        				"SORT":  30,
        			},
        			"1675": b24.Params{
        				"VALUE": "Completed",
        				"SORT":  40,
        			},
        			"1677": b24.Params{
        				"VALUE": "Deferred",
        				"SORT":  50,
        			},
        		},
        		"LIST_TEXT_VALUES": "Archive",
        		"LIST_DEF":         []string{"1671"},
        		"SETTINGS": b24.Params{
        			"SHOW_ADD_FORM":        "Y",
        			"SHOW_EDIT_FORM":       "Y",
        			"ADD_READ_ONLY_FIELD":  "N",
        			"EDIT_READ_ONLY_FIELD": "Y",
        			"SHOW_FIELD_PREVIEW":   "N",
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("lists.field.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": 1765371241,
                "finish": 1765371241.084551,
                "duration": 0.08455109596252441,
                "processing": 0,
                "date_start": "2025-12-09T16:54:01+01:00",
                "date_finish": "2025-12-09T16:54:01+01:00",
                "operating_reset_at": 1765371841,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Returns `true` if the field was successfully updated.
time `time`	Information about the request execution time.

Error Handling

HTTP status: 400

{
            "error":"ERROR_UPDATE_FIELD",
            "error_description":"Error updating the field."
        }

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

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	Information block not found.
`ERROR_UPDATE_FIELD`	Error updating the field	Error updating the field.
`ERROR_UPDATE_FIELD`	The default value of the field '...' is required	The `ADD_READ_ONLY_FIELD` setting is enabled, but `DEFAULT_VALUE` is not specified.
`ERROR_UPDATE_FIELD`	Incorrect lists specified for '...' property	Error in one of the parameters inside `FIELDS`.
`ACCESS_DENIED`	Access denied	Insufficient permissions to update the field.

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 Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	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
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not 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
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	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 `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	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

Continue Learning

Was the article helpful?

Create Field

Get Field Parameters or List of Fields

Update the Universal List Field lists.field.update

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