Add Configurable Activity crm.activity.configurable.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: crm

Who can execute the method: a user with edit access to the CRM object the activity is added to

The crm.activity.configurable.add method adds a configurable activity to the timeline of a CRM object.

The application defines the appearance of the entry itself: in the layout parameter it passes the structure — the icon, heading, content blocks, and buttons. Ready-made configurations are collected in the examples. Clicks on buttons, tags, and menu items reach the application as the onCrmTimelineItemAction event.

The method can only be called within the context of an application. Calling it via an inbound webhook returns the ERROR_WRONG_CONTEXT error.

Method Parameters

Required parameters are marked with *

Name
type

Description

ownerTypeId*
integer

Integer identifier of the CRM object type in whose element the activity is created, for example 2 for a deal

ownerId*
integer

Integer identifier of the CRM element in which the activity is created, for example 1

fields*
array

Associative array of values for the activity fields in the following structure:

{
            "typeId": "CONFIGURABLE",
            "completed": false,
            "deadline": "2025-02-01T12:00:00+03:00",
            "pingOffsets": [15, 60],
            "isIncomingChannel": "N",
            "responsibleId": 1,
            "badgeCode": "CUSTOM",
            "originatorId": "my_service",
            "originId": "42"
        }

The parameter is required, but it can be an empty array

layout*
LayoutDto

Structure that defines the appearance of the entry in the timeline. A ready-made object example is on the structure page

Parameter fields

All fields inside fields are optional. A field you do not pass gets its default value:

  • typeId — CONFIGURABLE
  • responsibleId — the user the application acts on behalf of
  • completed and isIncomingChannel — false
  • pingOffsets — an empty array
  • originatorId, originId, and badgeCode stay empty

Name
type

Description

typeId
string

Configurable activity type. A value other than CONFIGURABLE must match a type created by the same application with the crm.activity.type.add method and the IS_CONFIGURABLE_TYPE field equal to Y

completed
boolean

Whether the activity is closed. The value can be passed as Y/N, 1/0, or true/false

deadline
datetime

Deadline for the activity in ISO 8601 format, for example 2025-02-01T12:00:00+03:00. An incoming activity cannot be given a deadline — the method returns the INCOMING_ACTIVITY_CAN_NOT_BE_WITH_DEADLINE error

pingOffsets
array

Offsets in minutes relative to the deadline. They define when Bitrix24 creates ping records for this activity. Bitrix24 discards duplicate values

isIncomingChannel
boolean

Whether the activity was created from an incoming channel. The value can be passed as Y/N, 1/0, or true/false

responsibleId
integer

Identifier of the person responsible for the activity

badgeCode
string

Badge code — the icon on the card of a CRM object in the kanban. The badge must be registered beforehand with the crm.activity.badge.add method, otherwise the method returns the WRONG_FIELD_VALUE error

originatorId
string

Identifier of the data source

originId
string

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":"2025-02-01T12:00:00+03:00","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: '2025-02-01T12:00:00+03:00',
                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: '2025-02-01T12:00:00+03:00',
                    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>
        

        
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.activity.configurable.add(
                owner_type_id=1,
                owner_id=999,
                fields={
                    "typeId": "CONFIGURABLE",
                    "completed": True,
                    "deadline": "2025-02-01T12:00:00+03:00",
                    "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",
                            },
                        },
                    },
                },
            ).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.configurable.add',
                    [
                        'ownerTypeId' => 1,
                        'ownerId' => 999,
                        'fields' => [
                            'typeId' => 'CONFIGURABLE',
                            'completed' => true,
                            'deadline' => '2025-02-01T12:00:00+03:00',
                            '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: '2025-02-01T12:00:00+03:00',
                    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' => '2025-02-01T12:00:00+03:00',
                    '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>';
        }
        
// 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":          "2025-02-01T12:00:00+03:00",
        		"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
type

Description

result
object

Root element of the response with a single activity key (detailed description)

time
time

Information about the request execution time

Activity Object

Name
type

Description

id
integer

Identifier of the created activity. Pass it in the id parameter of the crm.activity.configurable.update and crm.activity.configurable.get methods

Error Handling

HTTP status: 400

{
            "error": "ERROR_WRONG_CONTEXT",
            "error_description": "The method can only be called within the context of a rest application"
        }

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

ACCESS_DENIED

Insufficient permissions to create an activity in the CRM object

100

The required ownerTypeId, ownerId, fields, or layout parameter is missing

ERROR_WRONG_CONTEXT

The method was called outside an application, for example via an inbound webhook

WRONG_FIELD_VALUE

Incorrect field value: an unknown badgeCode or typeId in fields, an unsupported nested block type, an invalid color format in sliderParams

INCOMING_ACTIVITY_CAN_NOT_BE_WITH_DEADLINE

Incoming activity cannot have a deadline

ERROR_EMPTY_LAYOUT

An empty layout was passed

FIELD_IS_REQUIRED

A required field was not passed in the structure object

FIELD_IS_REDUNDANT

A field was passed in the structure object that is not in its description

ENUM_FIELD

The field value is not in the list of allowed values, e.g., an unknown tag type

TOO_MANY_ITEMS

The number of array elements has been exceeded, e.g., more than two tags or buttons

KEY_CONTAIN_WRONG_SYMBOLS

The key in the structure associative array contains invalid characters. Only Latin letters, digits, hyphens, and underscores are allowed

WRONG_LANG

In a multi-language value, a language code was passed that is not installed in Bitrix24

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Previous
Delete Badge
Next
Update Configurable Activity