Изменить параметры хранилища entity.update

Scope: entity

Кто может выполнять метод: пользователь с уровнем права X (управление) на хранилище данных

Метод entity.update обновляет параметры хранилища данных приложения.

Метод работает только в контексте приложения.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
ENTITY^* `string`	Идентификатор хранилища данных приложения. Используйте значение, которое указали при создании хранилища. Получить идентификатор можно методом entity.get
NAME `string`	Новое название хранилища
ENTITY_NEW `string`	Новый идентификатор хранилища. Используется для переименования кода хранилища. Разрешены только символы `a-z`, `A-Z`, `0-9`, `_`. Максимальная длина рассчитывается динамически по формуле: `50 - strlen("APP_<clientId>_")`. В большинстве случаев для Битрикс24 это 13 символов
ACCESS `object`	Новый набор прав в формате `{"код_доступа":"уровень_права"}`. Примеры кодов доступа: `U<id>` — пользователь, например `U1` `G<id>` — группа пользователей, например `G2` `AU` — все авторизованные пользователи Метод принимает стандартные коды доступа Битрикс24. Проверить название кода можно методом access.name. Поддерживаемые уровни: `R` — чтение `W` — запись `X` — управление Если передан другой уровень, такая запись права не будет добавлена При передаче `ACCESS` текущему пользователю принудительно добавляется право `X` (`U<id>`)

Примеры кода

Как использовать примеры в документации

Пример обновления хранилища, где:

ENTITY — идентификатор текущего хранилища dish
NAME — новое название Dishes v2
ENTITY_NEW — новый код хранилища dish_v2
ACCESS — права доступа: U1 с уровнем W и AU с уровнем 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>';

Обработка ответа

HTTP-статус: 200

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

Возвращаемые данные

Название `тип`	Описание
result `boolean`	Результат выполнения метода. При успешном выполнении возвращается `true`
time `time`	Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error": "ERROR_ENTITY_NOT_FOUND",
            "error_description": "Entity not found"
        }

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

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание	Значение
`ERROR_ENTITY_NOT_FOUND`	Entity not found	Хранилище с переданным `ENTITY` не найдено
`ERROR_ENTITY_ALREADY_EXISTS`	Entity already exists	Хранилище с `ENTITY_NEW` уже существует
`ERROR_ARGUMENT`	Argument 'ENTITY' is null or empty	Параметр `ENTITY` не передан или пустой после очистки
`ERROR_ARGUMENT`	Entity code is too long. Max length is N characters.	Слишком длинное значение `ENTITY_NEW`
`ACCESS_DENIED`	Access denied!	Недостаточно прав для изменения хранилища
`ERROR_CORE`	Internal error updating entity. Try updating again.	Внутренняя ошибка при обновлении хранилища

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Создать хранилище данных

Получить параметры или список всех хранилищ

Изменить параметры хранилища entity.update

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение