Add Configurable 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 crm.activity.configurable.add method adds a configurable activity to the timeline.
Warning
The method can only be called within the context of an application.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
ownerTypeId* |
Integer CRM object type identifier where the activity is being created, e.g., |
|
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* |
Special structure associative array describing the appearance of the activity in the timeline |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
typeId |
Configurable activity type. If no value is specified, it is set to the default value |
|
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":"Klaus Weber","bold":true,"action":{"type":"redirect","uri":"/crm/lead/details/789/"}}},"phone":{"type":"text","properties":{"value":"+49 999 888 7777"}}}}}}},"footer":{"buttons":{"startCall":{"title":"About the client","action":{"type":"openRestApp","actionParams":{"clientId":456}},"type":"primary"}}}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.configurable.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
// Shape of the payload returned in result (match the "response handling" section of the page)
type AddConfigurableActivityResult = {
activity: {
id: number
}
}
try {
const response = await $b24.actions.v2.call.make<AddConfigurableActivityResult>({
method: 'crm.activity.configurable.add',
params: {
ownerTypeId: 1,
ownerId: 999,
fields: {
typeId: 'CONFIGURABLE',
completed: true,
deadline: new Date().toISOString(),
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: 'Sergei Vostrikov',
bold: true,
action: {
type: 'redirect',
uri: '/crm/lead/details/789/',
},
},
},
phone: {
type: 'text',
properties: {
value: '+49 999 888 7777',
},
},
},
},
},
},
},
footer: {
buttons: {
startCall: {
title: 'About client',
action: {
type: 'openRestApp',
actionParams: {
clientId: 456,
},
},
type: 'primary',
},
},
},
},
},
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('Added configurable activity, id:', result.activity.id)
}
} 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 addConfigurableActivity() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.activity.configurable.add',
params: {
ownerTypeId: 1,
ownerId: 999,
fields: {
typeId: 'CONFIGURABLE',
completed: true,
deadline: new Date().toISOString(),
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: 'Sergei Vostrikov',
bold: true,
action: {
type: 'redirect',
uri: '/crm/lead/details/789/',
},
},
},
phone: {
type: 'text',
properties: {
value: '+49 999 888 7777',
},
},
},
},
},
},
},
footer: {
buttons: {
startCall: {
title: 'About client',
action: {
type: 'openRestApp',
actionParams: {
clientId: 456,
},
},
type: 'primary',
},
},
},
},
},
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('Added configurable activity, id:', result.activity.id)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addConfigurableActivity)
</script>
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' => 'Klaus Weber',
'bold' => true,
'action' => [
'type' => 'redirect',
'uri' => '/crm/lead/details/789/',
],
],
],
'phone' => [
'type' => 'text',
'properties' => [
'value' => '+49 999 888 7777',
],
],
],
],
],
],
],
'footer' => [
'buttons' => [
'startCall' => [
'title' => 'About the client',
'action' => [
'type' => 'openRestApp',
'actionParams' => [
'clientId' => 456,
],
],
'type' => 'primary',
],
],
],
],
]
);
$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 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": "Klaus Weber",
"bold": true,
"action": {
"type": "redirect",
"uri": "/crm/lead/details/789/"
}
}
},
"phone": {
"type": "text",
"properties": {
"value": "+49 999 888 7777"
}
}
}
}
}
}
},
"footer": {
"buttons": {
"startCall": {
"title": "About the 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'), // We use the 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' => 'Klaus Weber',
'bold' => true,
'action' => [
'type' => 'redirect',
'uri' => '/crm/lead/details/789/'
]
]
],
'phone' => [
'type' => 'text',
'properties' => [
'value' => '+49 999 888 7777'
]
]
]
]
]
]
],
'footer' => [
'buttons' => [
'startCall' => [
'title' => 'About the 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>';
}
Example
from datetime import datetime, timedelta
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.activity.configurable.add(
owner_type_id=2,
owner_id=101,
fields={
"typeId": "CONFIGURABLE",
"completed": False,
"deadline": (datetime.now() + timedelta(hours=2)).isoformat(timespec="seconds"),
"pingOffsets": [15, 60],
"isIncomingChannel": "N",
"responsibleId": 1,
"badgeCode": "CUSTOM_STATUS",
},
layout={
"icon": {"code": "call-completed"},
"header": {"title": "Customer follow-up"},
"body": {
"blocks": {
"summary": {
"type": "text",
"properties": {"value": "Prepare proposal", "multiline": False},
},
},
},
"footer": {
"buttons": {
"openDeal": {
"title": "Open deal",
"action": {"type": "redirect", "uri": "/crm/deal/details/101/"},
"type": "primary",
},
},
},
},
).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}")
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.activity.configurable.add", b24.Params{
"ownerTypeId": 1,
"ownerId": 999,
"fields": b24.Params{
"typeId": "CONFIGURABLE",
"completed": true,
"deadline": "**put_current_date_time_here**",
"pingOffsets": []int{60, 300},
"isIncomingChannel": "N",
"responsibleId": 1,
"badgeCode": "CUSTOM",
},
"layout": b24.Params{
"icon": b24.Params{
"code": "call-completed",
},
"header": b24.Params{
"title": "Incoming call",
},
"body": b24.Params{
"logo": b24.Params{
"code": "call-incoming",
},
"blocks": b24.Params{
"responsible": b24.Params{
"type": "lineOfBlocks",
"properties": b24.Params{
"blocks": b24.Params{
"client": b24.Params{
"type": "link",
"properties": b24.Params{
"text": "Klaus Weber",
"bold": true,
"action": b24.Params{
"type": "redirect",
"uri": "/crm/lead/details/789/",
},
},
},
"phone": b24.Params{
"type": "text",
"properties": b24.Params{
"value": "+49 999 888 7777",
},
},
},
},
},
},
},
"footer": b24.Params{
"buttons": b24.Params{
"startCall": b24.Params{
"title": "About the client",
"action": b24.Params{
"type": "openRestApp",
"actionParams": b24.Params{
"clientId": 456,
},
},
"type": "primary",
},
},
},
},
})
if err != nil {
return fmt.Errorf("crm.activity.configurable.add: %w", err)
}
// The response arrives as json.RawMessage — unmarshal it
// into a struct matching the response shape shown below on this page.
fmt.Printf("%s\n", res.Result)
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 |
Response root element 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 |
|
|
A required field was not passed in the structure object |
|
|
A field was passed in the structure object that is not in its description |
|
|
The field value is not in the list of allowed values, e.g., an unknown tag type |
|
|
The number of array elements has been exceeded, e.g., more than two tags or buttons |
|
|
The key in the structure associative array contains invalid characters. Only Latin letters, digits, hyphens, and underscores are allowed |
|
|
In a multi-language value, a language code was passed that is not set on the portal |
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 |