Add Property to Data Storage Elements `entity.item.property.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 with access permission level X (management) in the data storage

The method entity.item.property.add adds a property to the elements 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.
PROPERTY^* `string`	Code of the new property. Allowed characters are `a-z`, `A-Z`, `0-9`, `_`
NAME `string`	Name of the property
TYPE `string`	Type of the property: `S` — string `N` — number `F` — file
SORT `integer`	Sorting index of the property

Code Examples

How to Use Examples in Documentation

Example of adding a property where:

ENTITY — identifier of the storage dish
PROPERTY — property code new_prop
NAME — name of the property
TYPE — type S
SORT — sorting index

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","NAME":"New Property","TYPE":"S","SORT":100,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/entity.item.property.add

try
        {
        	const response = await $b24.callMethod(
        		'entity.item.property.add',
        		{
        			ENTITY: 'dish',
        			PROPERTY: 'new_prop',
        			NAME: 'New Property',
        			TYPE: 'S',
        			SORT: 100,
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'entity.item.property.add',
                    [
                        'ENTITY' => 'dish',
                        'PROPERTY' => 'new_prop',
                        'NAME' => 'New Property',
                        'TYPE' => 'S',
                        'SORT' => 100,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding entity item property: ' . $e->getMessage();
        }

BX24.callMethod(
            'entity.item.property.add',
            {
                ENTITY: 'dish',
                PROPERTY: 'new_prop',
                NAME: 'New Property',
                TYPE: 'S',
                SORT: 100,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'entity.item.property.add',
            [
                'ENTITY' => 'dish',
                'PROPERTY' => 'new_prop',
                'NAME' => 'New Property',
                'TYPE' => 'S',
                'SORT' => 100,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1774440592,
                "finish": 1774440592.563202,
                "duration": 0.563201904296875,
                "processing": 0,
                "date_start": "2026-03-25T15:09:52+01:00",
                "date_finish": "2026-03-25T15:09:52+01:00",
                "operating_reset_at": 1774441192,
                "operating": 0
            }
        }

Returned Data

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

Error Handling

HTTP Status: 400

{
            "error": "ERROR_PROPERTY_ALREADY_EXISTS",
            "error_description": "Property already exists"
        }

{
            "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 is not provided or is empty after cleaning
`ERROR_ARGUMENT`	Entity code is too long. Max length is N characters.	The `ENTITY` value is too long
`ERROR_ARGUMENT`	Argument 'PROPERTY' is null or empty	The `PROPERTY` parameter is not provided
`ERROR_ARGUMENT`	Wrong entity item property type	An invalid `TYPE` was provided
`ERROR_ENTITY_NOT_FOUND`	Entity not found	Storage with the provided `ENTITY` was not found
`ERROR_PROPERTY_ALREADY_EXISTS`	Property already exists	A property with the provided `PROPERTY` already exists
`ACCESS_DENIED`	Access denied!	Insufficient permissions to add the property
`ACCESS_DENIED`	Access denied! Application context required	No application context (`clientId`)
`ERROR_UNSUPPORTED_PROPERTY_TYPE`	Invalid property type	Attempted to create a property with type `L`
`ERROR_CORE`	Internal error adding entity property. Try adding again.	Internal error while adding the property
`ERROR_CORE`	Property code cannot start with a digit	An invalid property code was provided in `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

Overview of Methods

Update Additional Property

Add Property to Data Storage Elements entity.item.property.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