Change Parameters of entity.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) on the data storage

The entity.update method updates the parameters of 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.
NAME `string`	New name for the storage.
ENTITY_NEW `string`	New identifier for the storage. Used for renaming the storage code. Only characters `a-z`, `A-Z`, `0-9`, `_` are allowed. The maximum length is calculated dynamically using the formula: `50 - strlen("APP_<clientId>_")`. In most cases for Bitrix24, this is 13 characters.
ACCESS `object`	New set of access permissions in the format `{"access_code":"permission_level"}`. Examples of access codes: `U<id>` — user, e.g., `U1` `G<id>` — user group, e.g., `G2` `AU` — all authorized users The method accepts standard access codes from Bitrix24. You can check the name of the code using the access.name method. Supported levels: `R` — read `W` — write `X` — management If a different level is provided, that access permission will not be added. When `ACCESS` is provided, the current user is forcibly granted permission `X` (`U<id>`).

Code Examples

How to Use Examples in Documentation

Example of updating the storage, where:

ENTITY — identifier of the current storage dish
NAME — new name Dishes v2
ENTITY_NEW — new storage code dish_v2
ACCESS — access permissions: U1 with level W and AU with level R

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ENTITY":"dish","NAME":"Dishes v2","ENTITY_NEW":"dish_v2","ACCESS":{"U1":"W","AU":"R"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/entity.update

try
        {
        	const response = await $b24.callMethod(
        		'entity.update',
        		{
        			ENTITY: 'dish',
        			NAME: 'Dishes v2',
        			ENTITY_NEW: 'dish_v2',
        			ACCESS: {
        				U1: 'W',
        				AU: 'R',
        			},
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'entity.update',
                    [
                        'ENTITY' => 'dish',
                        'NAME' => 'Dishes v2',
                        'ENTITY_NEW' => 'dish_v2',
                        'ACCESS' => [
                            'U1' => 'W',
                            'AU' => 'R',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating entity: ' . $e->getMessage();
        }

BX24.callMethod(
            'entity.update',
            {
                ENTITY: 'dish',
                NAME: 'Dishes v2',
                ENTITY_NEW: 'dish_v2',
                ACCESS: {
                    U1: 'W',
                    AU: 'R',
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'entity.update',
            [
                'ENTITY' => 'dish',
                'NAME' => 'Dishes v2',
                'ENTITY_NEW' => 'dish_v2',
                'ACCESS' => [
                    'U1' => 'W',
                    'AU' => 'R',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1774257803,
                "finish": 1774257803.550779,
                "duration": 0.5507791042327881,
                "processing": 0,
                "date_start": "2026-03-23T12:23:23+01:00",
                "date_finish": "2026-03-23T12:23:23+01:00",
                "operating_reset_at": 1774258403,
                "operating": 0.11757302284240723
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Result of the method execution. Returns `true` on successful execution.
time `time`	Information about the request execution time.

Error Handling

HTTP Status: 400

{
            "error": "ERROR_ENTITY_NOT_FOUND",
            "error_description": "Entity 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_ENTITY_NOT_FOUND`	Entity not found	Storage with the provided `ENTITY` not found.
`ERROR_ENTITY_ALREADY_EXISTS`	Entity already exists	Storage with `ENTITY_NEW` already exists.
`ERROR_ARGUMENT`	Argument 'ENTITY' is null or empty	Parameter `ENTITY` was not provided or is empty after cleaning.
`ERROR_ARGUMENT`	Entity code is too long. Max length is N characters.	`ENTITY_NEW` value is too long.
`ACCESS_DENIED`	Access denied!	Insufficient permissions to modify the storage.
`ERROR_CORE`	Internal error updating entity. Try updating again.	Internal error while updating the storage.

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

Create Data Storage

Retrieve Parameters or List All Storages

Change Parameters of entity.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