Add System Activity crm.activity.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:
crmWho can execute the method: a user with permission to modify each linked CRM entity
DEPRECATED
Method development has been discontinued. Use crm.activity.todo.add.
The crm.activity.add method creates a new system activity.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
An object containing activity field values (Detailed Description). Example structure:
The
|
Parameter fields
For the full list of fields and their descriptions, see crm.activity.fields. The fields below include details on how to pass them when creating an activity.
Specify a CRM entity using OWNER_TYPE_ID and OWNER_ID, or pass a valid link in COMMUNICATIONS. Creating an activity requires at least one link to a CRM entity.
The linked CRM entities must exist, and the user must have permission to modify each of them. In the examples, replace OWNER_TYPE_ID, OWNER_ID, ENTITY_TYPE_ID, and ENTITY_ID with the types and identifiers of accessible entities. If a communication includes VALUE but omits ENTITY_TYPE_ID or ENTITY_ID, the method uses OWNER_TYPE_ID and OWNER_ID for it.
Required parameters are marked with *
|
Field |
Description |
|
OWNER_ID |
Identifier of the CRM entity |
|
OWNER_TYPE_ID |
|
|
TYPE_ID |
Type of the activity. Required if To create an activity with the type "task", use the creation or modification method and specify the CRM entity in the |
|
COMMUNICATIONS |
An array of Communications. Required for calls, meetings, and emails; can be omitted for provider activities. Calls and meetings allow no more than one communication |
|
COMPLETED |
Activity completion flag: |
|
DEADLINE |
Date and time of the activity's deadline. The value passed is ignored: the activity provider calculates the deadline, and if it does not set one, |
|
DESCRIPTION |
Text description of the activity |
|
DESCRIPTION_TYPE |
Description type |
|
DIRECTION |
Direction of the activity: incoming/outgoing. Relevant for calls and emails, not used for meetings |
|
END_TIME |
Activity completion time |
|
FILES |
Files added to the activity |
|
LOCATION |
Location |
|
NOTIFY_TYPE |
Time unit for the reminder: |
|
NOTIFY_VALUE |
Number of |
|
ORIGINATOR_ID |
Identifier of the data source, used only for linking to an external source |
|
ORIGIN_ID |
Identifier of the entity in the data source, used only for linking to an external source |
|
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. If omitted, the method tries to use the user responsible for the CRM entity, then the current user |
|
SETTINGS |
Additional settings |
|
START_TIME |
Time when the activity starts |
|
STATUS |
Status of the activity |
|
SUBJECT* |
Activity subject. This field is required and cannot be empty |
|
WEBDAV_ELEMENTS |
Added files. For Drive storage, this field is deprecated and retained for compatibility; pass files in |
Field Value Usage Options
For activities of type e-mail:
- if the e-mail should not be sent, set the
DIRECTION=2andCOMPLETED='N'parameters - if it is necessary to mark e-mails as completed, perform an activity update 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":"+499832322323","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":"+499832322323","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
// 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<number>({
method: 'crm.activity.add',
params: {
fields: {
OWNER_TYPE_ID: 2,
OWNER_ID: 102,
TYPE_ID: 2,
COMMUNICATIONS: [
{ VALUE: '+499832322323', 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',
],
},
],
},
},
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('Created activity ID:', 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 addActivity() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.activity.add',
params: {
fields: {
OWNER_TYPE_ID: 2,
OWNER_ID: 102,
TYPE_ID: 2,
COMMUNICATIONS: [
{ VALUE: '+499832322323', 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',
],
},
],
},
},
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('Created activity ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addActivity)
</script>
from datetime import datetime, timedelta
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.activity.add(
fields={
"OWNER_TYPE_ID": 2,
"OWNER_ID": 101,
"TYPE_ID": 2,
"COMMUNICATIONS": [{"VALUE": "+499990000000"}],
"SUBJECT": "Follow up with customer",
"START_TIME": datetime.now().isoformat(timespec="seconds"),
"END_TIME": (datetime.now() + timedelta(hours=1)).isoformat(timespec="seconds"),
"COMPLETED": "N",
"RESPONSIBLE_ID": 1,
"PRIORITY": 2,
"DESCRIPTION": "Discuss proposal details",
"DESCRIPTION_TYPE": 3,
"DIRECTION": 2,
},
).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(
'crm.activity.add',
[
'fields' => [
'OWNER_TYPE_ID' => 2,
'OWNER_ID' => 102,
'TYPE_ID' => 2,
'COMMUNICATIONS' => [
['VALUE' => '+499832322323', '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);
// The data processing logic you need
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: "+499832322323", 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' => '+499832322323',
'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>';
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.activity.add", b24.Params{
"fields": b24.Params{
"OWNER_TYPE_ID": 2,
"OWNER_ID": 102,
"TYPE_ID": 2,
"COMMUNICATIONS": []b24.Params{
{
"VALUE": "+499832322323",
"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": []b24.Params{
{
"fileData": []string{"example.jpg", "base64_encoded_content_here"},
},
},
},
})
if err != nil {
return fmt.Errorf("crm.activity.add: %w", err)
}
var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("id:", newID)
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 |
Activity identifier in the timeline |
|
time |
Information about the request execution time |
Error Handling
When creating an outgoing completed email (TYPE_ID=4, COMPLETED=Y, DIRECTION=2), the method first saves the activity, then sends the email. If sending fails with an Email send error. ... error, the activity has already been created. Before calling the method again, check the Activity List to avoid creating a duplicate.
HTTP status: 400
{
"error": "",
"error_description": "Access denied."
}
|
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
|
Status |
Code |
Description |
Meaning |
|
|
Empty value |
|
The |
|
|
Empty value |
|
The user responsible for the activity could not be determined |
|
|
Empty value |
|
The |
|
|
Empty value |
|
No valid communications were provided for the call, meeting, or email |
|
|
Empty value |
|
More than one communication was provided for a call or meeting |
|
|
Empty value |
|
A link to a CRM entity could not be built from the owner and communications |
|
|
Empty value |
|
The linked CRM entity type is not supported; |
|
|
Empty value |
|
The linked CRM entity was not found; |
|
|
Empty value |
|
The activity type is not supported; |
|
|
Empty value |
|
The subscribe module could not be loaded |
|
|
Empty value |
|
Invalid email data |
|
|
Empty value |
|
An invalid email address was specified |
|
|
Empty value |
|
The email sender was not found |
|
|
Empty value |
|
The email recipient was not found |
|
|
Empty value |
|
The mailing could not be created; details are provided in the error message |
|
|
Empty value |
|
The mailing file could not be saved; details are provided in the error message |
|
|
Empty value |
|
The activity could not be updated when sending the email |
|
|
Empty value |
|
General email sending error |
|
|
Empty value |
|
No provider was found for the provider activity |
|
|
Empty value |
|
Use |
|
|
Empty value |
|
No permission to modify the linked CRM entity |
|
|
Empty value |
|
An activity with an application provider can only be created in the application context |
|
|
|
|
|
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 |
Continue Learning
- Update System CRM Activity crm.activity.update
- Get information about the activity by ID crm.activity.get
- Get List of Activities crm.activity.list
- Delete activity crm.activity.delete
- Get Communication Description crm.activity.communication.fields
- Get a list of fields for crm.activity.fields
- Add Calendar Event for Client Management
- How to Send an E-mail to a Client on Behalf of an Employee