Add Item to the Storage entity.item.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:
entityWho can execute the method: a user with access permission level
X(management) orW(write) in the data storage
The method entity.item.add adds an item to 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. |
|
NAME |
Name of the storage item. |
|
PROPERTY_VALUES |
Property values of the item in the format Only properties that exist in the storage are processed. A list of available property codes can be obtained using the entity.item.property.get method. For file-type properties, use the format described in the article How to Upload Files. |
|
SECTION |
Identifier of the storage section. |
|
DATE_ACTIVE_FROM |
Start date of the item's activity. |
|
DATE_ACTIVE_TO |
End date of the item's activity. |
|
PREVIEW_PICTURE |
Preview image of the item. File format is described in the article How to Upload Files. |
|
DETAIL_PICTURE |
Detailed image of the item. File format is described in the article How to Upload Files. |
|
UF_ |
Custom fields of the item Passed as separate parameters in the format |
Code Examples
How to Use Examples in Documentation
Example of adding an item where:
ENTITY— storage identifierdishNAME— name of the itemPROPERTY_VALUES— property valuesSECTION— section identifier
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ENTITY":"dish","NAME":"Hello, world!","PROPERTY_VALUES":{"test":11,"test1":22},"SECTION":219,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/entity.item.add
try
{
const response = await $b24.callMethod(
'entity.item.add',
{
ENTITY: 'dish',
NAME: 'Hello, world!',
PROPERTY_VALUES: {
test: 11,
test1: 22,
},
SECTION: 219,
}
);
const result = response.getData().result;
console.info(result);
}
catch (error)
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'entity.item.add',
[
'ENTITY' => 'dish',
'NAME' => 'Hello, world!',
'PROPERTY_VALUES' => [
'test' => 11,
'test1' => 22,
],
'SECTION' => 219,
]
);
$result = $response
->getResponseData()
->getResult();
echo '<pre>';
print_r($result);
echo '</pre>';
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding entity item: ' . $e->getMessage();
}
BX24.callMethod(
'entity.item.add',
{
ENTITY: 'dish',
NAME: 'Hello, world!',
PROPERTY_VALUES: {
test: 11,
test1: 22,
},
SECTION: 219,
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'entity.item.add',
[
'ENTITY' => 'dish',
'NAME' => 'Hello, world!',
'PROPERTY_VALUES' => [
'test' => 11,
'test1' => 22,
],
'SECTION' => 219,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": 2333,
"time": {
"start": 1774435185,
"finish": 1774435185.636041,
"duration": 0.6360409259796143,
"processing": 0,
"date_start": "2026-03-25T13:39:45+01:00",
"date_finish": "2026-03-25T13:39:45+01:00",
"operating_reset_at": 1774435785,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Identifier of the created item. |
|
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 |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
Argument 'ENTITY' is null or empty |
The |
|
|
Entity code is too long. Max length is N characters. |
The |
|
|
Field validation errors for the item |
Invalid input fields were provided. |
|
|
Entity not found |
The storage with the provided |
|
|
Access denied! |
Insufficient permissions to add the item. |
|
|
Access denied! Application context required |
No application context ( |
|
|
Internal error adding entity item. Try adding again. |
Internal error occurred while adding the item. |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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
- Update Entity Storage `entity.item.update`
- Get a List of Storage Items: entity.item.get
- Delete Entity Storage Method: entity.item.delete
- Data Storage Elements: Overview of Methods