Update List Element lists.element.update
Scope:
listsWho can execute the method: a user with "Edit" permission for the required list
The method lists.element.update updates a list element.
The method completely overwrites the element. Fields whose values are not provided will be cleared.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
IBLOCK_TYPE_ID* |
Identifier of the information block. Possible values:
|
|
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 must be specified: |
|
ELEMENT_ID* |
Identifier of the element. The identifier can be obtained using the lists.element.get method. |
|
ELEMENT_CODE* |
Symbolic code of the element. The code can be obtained using the lists.element.get method. At least one of the parameters must be specified: |
|
FIELDS* |
Array of fields. |
FIELDS Parameter
Required parameters are marked with *
|
Name |
Description |
|
NAME* |
Name of the element |
|
PROPERTY_PropertyId |
Custom properties. Any property of the element can be configured as multiple. For multiple properties, pass an array, even if there is only one value. To pass a value in a File type field, specify:
More about working with files in the article How to Update and Delete Files |
You can get data about the list fields using the lists.field.get method.
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":47,"ELEMENT_ID":6999,"FIELDS":{"NAME":"Test Element (updated)","PROPERTY_951":["1269"]}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/lists.element.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":47,"ELEMENT_ID":6999,"FIELDS":{"NAME":"Test Element (updated)","PROPERTY_951":["1269"]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/lists.element.update
try
{
const response = await $b24.callMethod(
'lists.element.update',
{
IBLOCK_TYPE_ID: 'lists',
IBLOCK_ID: 47,
ELEMENT_ID: 6999,
FIELDS: {
NAME: 'Test Element (updated)',
PROPERTY_951: ["1269"]
}
}
);
const result = response.getData().result;
console.log('Updated element with ID:', result);
processResult(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'lists.element.update',
[
'IBLOCK_TYPE_ID' => 'lists',
'IBLOCK_ID' => 47,
'ELEMENT_ID' => 6999,
'FIELDS' => [
'NAME' => 'Test Element (updated)',
'PROPERTY_951' => ["1269"]
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating element: ' . $e->getMessage();
}
BX24.callMethod(
'lists.element.update',
{
IBLOCK_TYPE_ID: 'lists',
IBLOCK_ID: 47,
ELEMENT_ID: 6999,
FIELDS: {
NAME: 'Test Element (updated)',
PROPERTY_951: ["1269"]
}
},
function(res) {
if (res.error()) {
console.error('Update error:', res.error());
} else {
console.log('Element successfully updated:', res.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'lists.element.update',
[
'IBLOCK_TYPE_ID' => 'lists',
'IBLOCK_ID' => 47,
'ELEMENT_ID' => 6999,
'FIELDS' => [
'NAME' => 'Test Element (updated)',
'PROPERTY_951' => ["1269"]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": true,
"time": {
"start": 1763658078,
"finish": 1763658078.767221,
"duration": 0.7672209739685059,
"processing": 0,
"date_start": "2025-11-19T15:01:18+01:00",
"date_finish": "2025-11-19T15:01:18+01:00",
"operating_reset_at": 1763658678,
"operating": 0.1465599536895752
}
}
Returned Data
|
Name |
Description |
|
result |
Returns |
|
time |
Information about the request execution time. |
Error Handling
HTTP status: 400
{
"error":"ERROR_ELEMENT_FIELD_VALUE",
"error_description":"Writing file values by ID is not supported"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
Required parameter |
Required parameter not provided. |
|
|
Iblock not found |
Information block not found. |
|
|
Element not found |
Element with such |
|
|
— |
Error updating the element. |
|
|
Writing file values by ID is not supported |
Field value validation error. |
|
|
Access denied |
Insufficient permissions to update the element. |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Create a list element lists.element.add
- Get parameters of an element or a list of elements lists.element.get
- Delete List Element lists.element.delete
- Get File Path lists.element.get.file.url