Add a Storage Item Property entity.item.property.add
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
entityWho can execute the method: a user with access permission level
X(management) on the data storage
The method entity.item.property.add adds a property to the items of the application's data storage.
The method works only in the context of the application.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
ENTITY* |
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* |
Code of the new property. Allowed characters are |
|
NAME |
Name of the property |
|
TYPE |
Type of the property:
|
|
SORT |
Sorting index of the property |
Code Examples
How to Use Examples in Documentation
Example of adding a property where:
ENTITY— identifier of the storagedishPROPERTY— property codenew_propNAME— name of the propertyTYPE— typeSSORT— sorting index
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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'entity.item.property.add',
params: {
ENTITY: 'dish',
PROPERTY: 'new_prop',
NAME: 'New property',
TYPE: 'S',
SORT: 100,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Property added:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addEntityItemProperty() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'entity.item.property.add',
params: {
ENTITY: 'dish',
PROPERTY: 'new_prop',
NAME: 'New property',
TYPE: 'S',
SORT: 100,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Property added:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addEntityItemProperty)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.entity.item.property.add(
entity="dish",
property="new_prop",
name="New property",
type="S",
sort=100,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected 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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "entity.item.property.add", b24.Params{
"ENTITY": "dish",
"PROPERTY": "new_prop",
"NAME": "New Property",
"TYPE": "S",
"SORT": 100,
})
if err != nil {
return fmt.Errorf("entity.item.property.add: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("done:", ok)
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 |
Description |
|
result |
Result of adding the property ( |
|
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 |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Argument 'ENTITY' is null or empty |
The |
|
|
Entity code is too long. Max length is N characters. |
The |
|
|
Argument 'PROPERTY' is null or empty |
The |
|
|
Wrong entity item property type |
An invalid |
|
|
Entity not found |
Storage with the provided |
|
|
Property already exists |
A property with the provided |
|
|
Access denied! |
Insufficient permissions to add the property |
|
|
Access denied! Application context required |
No application context ( |
|
|
Invalid property type |
Attempted to create a property with type |
|
|
Internal error adding entity property. Try adding again. |
Internal error while adding the property |
|
|
Property code cannot start with a digit |
An invalid property code was provided in |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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 |