Add System Activity crm.activity.add
Scope:
crmWho can execute the method: user with permission to add an activity
Method development has been halted
The method crm.activity.add continues to function, but there is a more relevant alternative crm.activity.todo.add.
The method crm.activity.add creates a new system activity.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Array of values for activity fields in the following structure:
There is an additional field
|
Parameter fields
Required parameters are marked with *
|
Field |
Description |
|
|
OWNER_ID* |
Identifier of the CRM entity |
|
|
OWNER_TYPE_ID* |
||
|
TYPE_ID* |
Type of the deal. To access the available deal types, use the method crm.enum.activitytype. To create a deal with the type "task," use the method creation or modification of the task and specify the CRM entity in the field |
|
|
ASSOCIATED_ENTITY_ID |
Identifier of the entity associated with the activity |
|
|
COMMUNICATIONS* |
||
|
DEADLINE |
Date and time of the activity deadline. The field is not set directly; the value is taken from START_TIME for calls and meetings and from END_TIME for tasks |
|
|
DESCRIPTION |
Text description of the activity |
|
|
DESCRIPTION_TYPE |
Type of description |
|
|
DIRECTION |
Direction of the activity: incoming/outgoing. Relevant for calls and emails, not used for meetings |
|
|
END_TIME |
End time of the activity |
|
|
FILES |
Files added to the activity |
|
|
LOCATION |
Location |
|
|
NOTIFY_TYPE |
Type of notification |
|
|
ORIGINATOR_ID |
Identifier of the data source, used only for binding to an external source |
|
|
ORIGIN_ID |
Identifier of the entity in the data source, used only for binding to an external source |
|
|
ORIGIN_VERSION |
Original version, used to protect data from accidental overwriting by an external system. If the data was imported and not changed in the external system, such data can be edited in CRM without fear that the next export will lead to data overwriting |
|
|
PRIORITY |
Priority |
|
|
PROVIDER_DATA |
Additional provider data |
|
|
PROVIDER_GROUP_ID |
Identifier of the provider group |
|
|
PROVIDER_ID |
Identifier of the provider |
|
|
PROVIDER_TYPE_ID |
Identifier of the provider type, status from the directory |
|
|
PROVIDER_PARAMS |
Additional provider parameters |
|
|
RESPONSIBLE_ID* |
Identifier of the user responsible for the activity |
|
|
SETTINGS |
Additional settings |
|
|
START_TIME |
Start time of the activity |
|
|
STATUS |
Status of the activity |
|
|
SUBJECT |
Additional description of the activity |
|
|
WEBDAV_ELEMENTS |
Added files. Deprecated, kept for compatibility |
|
|
IS_INCOMING_CHANNEL |
Flag indicating whether the activity was created from an incoming channel ( |
Value Usage Examples for Fields
For activities of type e-mail:
- if the email should not be sent, set parameters
DIRECTION=2andCOMPLETED='N'; - if it is necessary to mark emails as completed, update the activities by setting the completion flag.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"OWNER_TYPE_ID":2,"OWNER_ID":102,"TYPE_ID":2,"COMMUNICATIONS":[{"VALUE":"+18005551234","ENTITY_ID":134,"ENTITY_TYPE_ID":3}],"SUBJECT":"New call","START_TIME":"2023-12-31T12:00:00+00:00","END_TIME":"2023-12-31T12:30:00+00:00","COMPLETED":"N","PRIORITY":3,"RESPONSIBLE_ID":1,"DESCRIPTION":"Important call","DESCRIPTION_TYPE":3,"DIRECTION":2,"FILES":[{"fileData":["example.jpg","base64_encoded_content_here"]}]} }' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"OWNER_TYPE_ID":2,"OWNER_ID":102,"TYPE_ID":2,"COMMUNICATIONS":[{"VALUE":"+18005551234","ENTITY_ID":134,"ENTITY_TYPE_ID":3}],"SUBJECT":"New call","START_TIME":"2023-12-31T12:00:00+00:00","END_TIME":"2023-12-31T12:30:00+00:00","COMPLETED":"N","PRIORITY":3,"RESPONSIBLE_ID":1,"DESCRIPTION":"Important call","DESCRIPTION_TYPE":3,"DIRECTION":2,"FILES":[{"fileData":["example.jpg","base64_encoded_content_here"]}]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.add
try
{
const response = await $b24.callMethod(
"crm.activity.add",
{
fields: {
"OWNER_TYPE_ID": 2,
"OWNER_ID": 102,
"TYPE_ID": 2,
"COMMUNICATIONS": [
{ VALUE: "+18005551234", ENTITY_ID: 134, ENTITY_TYPE_ID: 3 }
],
"SUBJECT": "New call",
"START_TIME": "2023-12-31T12:00:00+00:00", // Example date and time
"END_TIME": "2023-12-31T12:30:00+00:00", // Example date and time
"COMPLETED": "N",
"PRIORITY": 3,
"RESPONSIBLE_ID": 1,
"DESCRIPTION": "Important call",
"DESCRIPTION_TYPE": 3,
"DIRECTION": 2,
"FILES": [
{
fileData: [
"example.jpg", // File name
"base64_encoded_content_here" // File content in base64 format
]
}
]
}
}
);
const result = response.getData().result;
console.dir(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'crm.activity.add',
[
'fields' => [
'OWNER_TYPE_ID' => 2,
'OWNER_ID' => 102,
'TYPE_ID' => 2,
'COMMUNICATIONS' => [
['VALUE' => '+18005551234', 'ENTITY_ID' => 134, 'ENTITY_TYPE_ID' => 3]
],
'SUBJECT' => 'New call',
'START_TIME' => '2023-12-31T12:00:00+00:00',
'END_TIME' => '2023-12-31T12:30:00+00:00',
'COMPLETED' => 'N',
'PRIORITY' => 3,
'RESPONSIBLE_ID' => 1,
'DESCRIPTION' => 'Important call',
'DESCRIPTION_TYPE' => 3,
'DIRECTION' => 2,
'FILES' => [
[
'fileData' => [
'example.jpg',
'base64_encoded_content_here'
]
]
]
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your logic for processing data
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding activity: ' . $e->getMessage();
}
BX24.callMethod(
"crm.activity.add",
{
fields: {
"OWNER_TYPE_ID": 2,
"OWNER_ID": 102,
"TYPE_ID": 2,
"COMMUNICATIONS": [
{ VALUE: "+18005551234", ENTITY_ID: 134, ENTITY_TYPE_ID: 3 }
],
"SUBJECT": "New call",
"START_TIME": "2023-12-31T12:00:00+00:00", // Example date and time
"END_TIME": "2023-12-31T12:30:00+00:00", // Example date and time
"COMPLETED": "N",
"PRIORITY": 3,
"RESPONSIBLE_ID": 1,
"DESCRIPTION": "Important call",
"DESCRIPTION_TYPE": 3,
"DIRECTION": 2,
"FILES": [
{
fileData: [
"example.jpg", // File name
"base64_encoded_content_here" // File content in base64 format
]
}
]
}
},
result => {
if (result.error()) {
console.error(result.error());
} else {
console.dir(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.add',
[
'fields' => [
'OWNER_TYPE_ID' => 2,
'OWNER_ID' => 102,
'TYPE_ID' => 2,
'COMMUNICATIONS' => [
[
'VALUE' => '+18005551234',
'ENTITY_ID' => 134,
'ENTITY_TYPE_ID' => 3
]
],
'SUBJECT' => 'New call',
'START_TIME' => '2023-12-31T12:00:00+00:00', // Example date and time
'END_TIME' => '2023-12-31T12:30:00+00:00', // Example date and time
'COMPLETED' => 'N',
'PRIORITY' => 3,
'RESPONSIBLE_ID' => 1,
'DESCRIPTION' => 'Important call',
'DESCRIPTION_TYPE' => 3,
'DIRECTION' => 2,
'FILES' => [
[
'fileData' => [
'example.jpg', // File name
'base64_encoded_content_here' // File content in base64 format
]
]
]
]
]
);
if (isset($result['error'])) {
echo 'Error: ' . $result['error_description'];
} else {
echo '<PRE>';
print_r($result['result']);
echo '</PRE>';
}
Response Handling
HTTP status: 200
{
"result": 999,
"time": {
"start": 1712132792.910734,
"finish": 1712132793.530359,
"duration": 0.6196250915527344,
"processing": 0.032338857650756836,
"date_start": "2024-04-03T10:26:32+02:00",
"date_finish": "2024-04-03T10:26:33+02:00",
"operating_reset_at": 1705765533,
"operating": 3.3076241016387939
}
}
Returned Data
|
Name |
Description |
|
result |
Result of the operation. Returns the identifier of the activity in the timeline in case of success, otherwise — |
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 400
{
"error": "",
"error_description": "Access denied."
}
|
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 |
|
|
The |
|
|
The |
|
|
The |
|
|
The |
|
|
More than one contact is specified |
|
|
Connections for the activity are not specified |
|
Errors related to "email" activities |
|
|
Activity type is not supported in the specified context |
|
|
Incorrect method call for configurable activity |
|
|
No permission to add an entity in CRM |
|
|
Incorrect |
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 allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Update System Activity crm.activity.update
- Delete activity crm.activity.delete
- Get information about the activity by ID crm.activity.get
- Get the list of activities crm.activity.list
- Get Description of Communication crm.activity.communication.fields
- Get a list of fields for crm.activity.fields
- Add Calendar Event for Client Interaction
- How to Send an Email to a Client on Behalf of an Employee