Add Configurable CRM Activity crm.activity.configurable.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:
crmWho can execute the method: any user
The method crm.activity.configurable.add adds a configurable activity to the timeline.
Warning
The method can only be called in the context of an application.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
ownerTypeId* |
Integer identifier of the CRM entity type in which the activity is created, for example |
|
ownerId* |
Integer identifier of the CRM element in which the activity is created, for example |
|
fields* |
Associative array of values for the activity fields in the following structure: |
|
layout* |
Associative array of a special structure describing the appearance of the activity in the timeline |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
typeId |
Type of the configurable activity. If not specified, it defaults to |
|
completed |
Flag indicating whether the activity is closed. You can use |
|
deadline |
Deadline for the activity |
|
pingOffsets |
Array of offsets in minutes relative to the deadline, determining when to create ping records for this activity |
|
isIncomingChannel |
Flag indicating whether the activity was created from an incoming channel. You can use |
|
responsibleId |
Responsible person for the activity |
|
badgeCode |
Code of the badge on the kanban corresponding to the activity |
|
originatorId |
Identifier of the data source |
|
originId |
Identifier of the element in the data source |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ownerTypeId":1,"ownerId":999,"fields":{"typeId":"CONFIGURABLE","completed":true,"deadline":"**put_current_date_time_here**","pingOffsets":[60,300],"isIncomingChannel":"N","responsibleId":1,"badgeCode":"CUSTOM"},"layout":{"icon":{"code":"call-completed"},"header":{"title":"Incoming Call"},"body":{"logo":{"code":"call-incoming"},"blocks":{"responsible":{"type":"lineOfBlocks","properties":{"blocks":{"client":{"type":"link","properties":{"text":"John Doe","bold":true,"action":{"type":"redirect","uri":"/crm/lead/details/789/"}}},"phone":{"type":"text","properties":{"value":"+1 999 888 7777"}}}}}}},"footer":{"buttons":{"startCall":{"title":"About Client","action":{"type":"openRestApp","actionParams":{"clientId":456}},"type":"primary"}}}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.configurable.add
try
{
const response = await $b24.callMethod(
"crm.activity.configurable.add",
{
ownerTypeId: 1,
ownerId: 999,
fields:
{
typeId: 'CONFIGURABLE',
completed: true,
deadline: new Date(),
pingOffsets: [60, 300],
isIncomingChannel: 'N',
responsibleId: 1,
badgeCode: 'CUSTOM',
},
layout:
{
"icon": {
"code": "call-completed"
},
"header": {
"title": "Incoming Call"
},
"body": {
"logo": {
"code": "call-incoming"
},
"blocks": {
"responsible": {
"type": "lineOfBlocks",
"properties": {
"blocks": {
"client": {
"type": "link",
"properties": {
"text": "John Doe",
"bold": true,
"action": {
"type": "redirect",
"uri": "/crm/lead/details/789/"
}
}
},
"phone": {
"type": "text",
"properties": {
"value": "+1 999 888 7777"
}
}
}
}
}
}
},
"footer": {
"buttons": {
"startCall": {
"title": "About Client",
"action": {
"type": "openRestApp",
"actionParams": {
"clientId": 456
}
},
"type": "primary"
}
}
}
}
}
);
const result = response.getData().result;
console.dir(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'crm.activity.configurable.add',
[
'ownerTypeId' => 1,
'ownerId' => 999,
'fields' => [
'typeId' => 'CONFIGURABLE',
'completed' => true,
'deadline' => new DateTime(),
'pingOffsets' => [60, 300],
'isIncomingChannel' => 'N',
'responsibleId' => 1,
'badgeCode' => 'CUSTOM',
],
'layout' => [
'icon' => [
'code' => 'call-completed',
],
'header' => [
'title' => 'Incoming Call',
],
'body' => [
'logo' => [
'code' => 'call-incoming',
],
'blocks' => [
'responsible' => [
'type' => 'lineOfBlocks',
'properties' => [
'blocks' => [
'client' => [
'type' => 'link',
'properties' => [
'text' => 'John Doe',
'bold' => true,
'action' => [
'type' => 'redirect',
'uri' => '/crm/lead/details/789/',
],
],
],
'phone' => [
'type' => 'text',
'properties' => [
'value' => '+1 999 888 7777',
],
],
],
],
],
],
],
'footer' => [
'buttons' => [
'startCall' => [
'title' => 'About Client',
'action' => [
'type' => 'openRestApp',
'actionParams' => [
'clientId' => 456,
],
],
'type' => 'primary',
],
],
],
],
]
);
$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 configurable activity: ' . $e->getMessage();
}
BX24.callMethod(
"crm.activity.configurable.add",
{
ownerTypeId: 1,
ownerId: 999,
fields:
{
typeId: 'CONFIGURABLE',
completed: true,
deadline: new Date(),
pingOffsets: [60, 300],
isIncomingChannel: 'N',
responsibleId: 1,
badgeCode: 'CUSTOM',
},
layout:
{
"icon": {
"code": "call-completed"
},
"header": {
"title": "Incoming Call"
},
"body": {
"logo": {
"code": "call-incoming"
},
"blocks": {
"responsible": {
"type": "lineOfBlocks",
"properties": {
"blocks": {
"client": {
"type": "link",
"properties": {
"text": "John Doe",
"bold": true,
"action": {
"type": "redirect",
"uri": "/crm/lead/details/789/"
}
}
},
"phone": {
"type": "text",
"properties": {
"value": "+1 999 888 7777"
}
}
}
}
}
}
},
"footer": {
"buttons": {
"startCall": {
"title": "About Client",
"action": {
"type": "openRestApp",
"actionParams": {
"clientId": 456
}
},
"type": "primary"
}
}
}
}
}, result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.configurable.add',
[
'ownerTypeId' => 1,
'ownerId' => 999,
'fields' => [
'typeId' => 'CONFIGURABLE',
'completed' => true,
'deadline' => date('c'), // Use current date and time in ISO 8601 format
'pingOffsets' => [60, 300],
'isIncomingChannel' => 'N',
'responsibleId' => 1,
'badgeCode' => 'CUSTOM',
],
'layout' => [
'icon' => [
'code' => 'call-completed'
],
'header' => [
'title' => 'Incoming Call'
],
'body' => [
'logo' => [
'code' => 'call-incoming'
],
'blocks' => [
'responsible' => [
'type' => 'lineOfBlocks',
'properties' => [
'blocks' => [
'client' => [
'type' => 'link',
'properties' => [
'text' => 'John Doe',
'bold' => true,
'action' => [
'type' => 'redirect',
'uri' => '/crm/lead/details/789/'
]
]
],
'phone' => [
'type' => 'text',
'properties' => [
'value' => '+1 999 888 7777'
]
]
]
]
]
]
],
'footer' => [
'buttons' => [
'startCall' => [
'title' => 'About Client',
'action' => [
'type' => 'openRestApp',
'actionParams' => [
'clientId' => 456
]
},
'type' => 'primary'
]
]
]
]
]
);
if (isset($result['error'])) {
echo 'Error: ' . $result['error_description'];
} else {
echo '<PRE>';
print_r($result['result']);
echo '</PRE>';
}
Response Handling
HTTP Status: 200
{
"result": {
"activity": {
"id": 999,
},
"time": {
"start": 1724068028.331234,
"finish": 1724068028.726591,
"duration": 0.3953571319580078,
"processing": 0.13033390045166016,
"date_start": "2025-01-21T13:47:08+02:00",
"date_finish": "2025-01-21T13:47:08+02:00",
"operating": 0
}
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response containing information about the added activity identifier |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "NOT_FOUND",
"error_description": "Not found."
}
|
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 |
|
|
Insufficient permissions to perform the operation |
|
|
Required fields are not filled |
|
|
Method call is only possible in the context of an application |
|
|
The activity can only be updated by the application that created it |
|
|
Incorrect field value |
|
|
Incoming activity cannot have a deadline |
|
|
The layout field must be filled |
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 Configurable Activity crm.activity.configurable.update
- Get Configurable Activity by ID crm.activity.configurable.get