Create a Data Storage entity.add

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 authorized in the application

The entity.add method creates a new data storage for the application.

The method works only in the context of the application.

Method Parameters

Required parameters are marked with *

Name `type`	Description
ENTITY^* `string`	Character identifier for the storage. Use this value in other methods of the section after creating the storage. Allowed characters are `a-z`, `A-Z`, `0-9`, `_`. The length limit is calculated dynamically using the formula: `50 - strlen("APP_<clientId>_")`. In most cases for Bitrix24, this is 13 characters
NAME^* `string`	Name of the storage
ACCESS `object`	Access permissions in the format `{"access_code":"permission_level"}`. Examples of access codes: `U<id>` — user, for example `U1` `G<id>` — user group, for example `G2` `AU` — all authorized users The method accepts standard access codes for Bitrix24. You can check the name of the code using the access.name method. Supported levels: `R` — read `W` — write `X` — manage If another level is provided, that permission entry will not be added. The Creator of the storage is automatically granted the `X` permission (`U<id>`)

Code Examples

How to Use Examples in Documentation

Example of creating a data storage where:

ENTITY — storage identifier dish
NAME — storage name Dishes
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","ACCESS":{"U1":"W","AU":"R"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/entity.add

try
        {
        	const response = await $b24.callMethod(
        		'entity.add',
        		{
        			ENTITY: 'dish',
        			NAME: 'Dishes',
        			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.add',
                    [
                        'ENTITY' => 'dish',
                        'NAME' => 'Dishes',
                        '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 adding entity: ' . $e->getMessage();
        }

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

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

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1774255192,
                "finish": 1774255192.416864,
                "duration": 0.41686391830444336,
                "processing": 0,
                "date_start": "2026-03-23T11:39:52+02:00",
                "date_finish": "2026-03-23T11:39:52+02:00",
                "operating_reset_at": 1774255792,
                "operating": 0.11449217796325684
            }
        }

Returned Data

Name `type`	Description
result `boolean`	The result of the method execution. Returns `true` for successful creation
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "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_ALREADY_EXISTS`	Entity already exists	A storage with this `ENTITY` already exists
`ERROR_CORE`	Internal error adding entity. Try adding again.	Internal error while creating the storage
`ERROR_ARGUMENT`	Argument 'ENTITY' is null or empty	The `ENTITY` parameter was not provided or is empty after clearing
`ERROR_ARGUMENT`	Entity code is too long. Max length is N characters.	The `ENTITY` value is too long
`ACCESS_DENIED`	Access denied! Application context required	No application context (`clientId`)

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

Overview of Methods

Modify Storage Parameters

Create a Data Storage entity.add

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