Update Property of Storage Elements `entity.item.property.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: entity

Who can execute the method: a user with access permission level X (management) in the data storage

The method entity.item.property.update modifies the property of elements in the application's data storage.

The method works only in the context of the application.

Method Parameters

Required parameters are marked with *

Name `type`	Description
ENTITY^* `string`	Identifier of the application's data storage. Use the value specified when creating the storage. You can obtain the identifier using the entity.get method.
PROPERTY^* `string`	Code of the existing property to be modified. You can obtain the property code using the entity.item.property.get method.
PROPERTY_NEW `string`	New property code. Allowed characters are `a-z`, `A-Z`, `0-9`, `_`
NAME `string`	New property name.
TYPE `string`	New property type: `S` — string `N` — number `F` — file
SORT `integer`	Property sort index.

Code Examples

How to Use Examples in Documentation

Example of updating a property where:

ENTITY — storage identifier dish
PROPERTY — original property code new_prop
PROPERTY_NEW — new property code updated_prop
NAME, SORT — new values

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ENTITY":"dish","PROPERTY":"new_prop","PROPERTY_NEW":"updated_prop","NAME":"Updated Property","SORT":200,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/entity.item.property.update

try
        {
        	const response = await $b24.callMethod(
        		'entity.item.property.update',
        		{
        			ENTITY: 'dish',
        			PROPERTY: 'new_prop',
        			PROPERTY_NEW: 'updated_prop',
        			NAME: 'Updated Property',
        			SORT: 200,
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'entity.item.property.update',
                    [
                        'ENTITY' => 'dish',
                        'PROPERTY' => 'new_prop',
                        'PROPERTY_NEW' => 'updated_prop',
                        'NAME' => 'Updated Property',
                        'SORT' => 200,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating entity item property: ' . $e->getMessage();
        }

BX24.callMethod(
            'entity.item.property.update',
            {
                ENTITY: 'dish',
                PROPERTY: 'new_prop',
                PROPERTY_NEW: 'updated_prop',
                NAME: 'Updated Property',
                SORT: 200,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'entity.item.property.update',
            [
                'ENTITY' => 'dish',
                'PROPERTY' => 'new_prop',
                'PROPERTY_NEW' => 'updated_prop',
                'NAME' => 'Updated Property',
                'SORT' => 200,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1774442553,
                "finish": 1774442553.149827,
                "duration": 0.1498270034790039,
                "processing": 0,
                "date_start": "2026-03-25T15:42:33+02:00",
                "date_finish": "2026-03-25T15:42:33+02:00",
                "operating_reset_at": 1774443153,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Result of the property update (`true` — successful)
time `time`	Information about the request execution time.

Error Handling

HTTP Status: 400

{
            "error": "ERROR_PROPERTY_NOT_FOUND",
            "error_description": "Property not found"
        }

{
            "error": "ERROR_ARGUMENT",
            "error_description": "Argument 'ENTITY' is null or empty",
            "argument": "ENTITY"
        }

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_ARGUMENT`	Argument 'ENTITY' is null or empty	The `ENTITY` parameter was not provided or is empty after cleaning.
`ERROR_ARGUMENT`	Entity code is too long. Max length is N characters.	The value of `ENTITY` is too long.
`ERROR_ARGUMENT`	Wrong entity item property type	An invalid `TYPE` was provided.
`ERROR_ARGUMENT`	Cannot change property type to File	Attempting to change the property type to `F`.
`ERROR_ENTITY_NOT_FOUND`	Entity not found	The storage with the provided `ENTITY` was not found.
`ERROR_PROPERTY_NOT_FOUND`	Property not found	The property with the provided `PROPERTY` was not found.
`ERROR_PROPERTY_ALREADY_EXISTS`	Property <PROPERTY_NEW> already exists	A property with the code `PROPERTY_NEW` already exists.
`ACCESS_DENIED`	Access denied!	Insufficient permissions to modify the property.
`ACCESS_DENIED`	Access denied! Application context required	No application context (`clientId`).
`ERROR_CORE`	Internal error updating entity property. Try updating again.	An internal error occurred while updating the property.

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

Add Additional Property

Retrieve List of Properties

Update Property of Storage Elements entity.item.property.update

Method ParametersMethod Parameters

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