Add Custom Activity Type crm.activity.type.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: administrator
The crm.activity.type.add method registers a custom activity type by specifying a name and an icon.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Field values for adding a new custom activity type in the form of a structure:
A detailed description is provided below |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
TYPE_ID* |
String value of the deal type, for example |
|
NAME |
Name of the deal type, for example |
|
ICON_FILE |
Icon file for the activity type, described according to rules |
|
IS_CONFIGURABLE_TYPE |
Default value is |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TYPE_ID":"1C","NAME":"Case 1C","ICON_FILE":"@type-icon","IS_CONFIGURABLE_TYPE":"N"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.type.add
After this, you only need to specify your type when creating an activity, and the icon and name will be loaded automatically.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"OWNER_TYPE_ID":1,"OWNER_ID":selectedEntityId,"PROVIDER_ID":"REST_APP","PROVIDER_TYPE_ID":"1C","SUBJECT":"New case","COMPLETED":"N","RESPONSIBLE_ID":1,"DESCRIPTION":"Description of the new case"},"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<boolean>({
method: 'crm.activity.type.add',
params: {
fields: {
TYPE_ID: '1C',
NAME: '1C activity',
ICON_FILE: document.getElementById('type-icon'), // file input node
IS_CONFIGURABLE_TYPE: 'N',
},
},
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('Activity type added:', 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 addActivityType() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.activity.type.add',
params: {
fields: {
TYPE_ID: '1C',
NAME: '1C activity',
ICON_FILE: document.getElementById('type-icon'), // file input node
IS_CONFIGURABLE_TYPE: 'N',
},
},
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('Activity type added:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addActivityType)
</script>
try {
$response = $b24Service
->core
->call(
'crm.activity.type.add',
[
'fields' => [
'TYPE_ID' => '1C',
'NAME' => 'Case 1C',
'ICON_FILE' => $_FILES['type-icon'], // file input node
'IS_CONFIGURABLE_TYPE' => 'N',
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding activity type: ' . $e->getMessage();
}
BX24.callMethod(
"crm.activity.type.add",
{
fields:
{
"TYPE_ID": '1C',
"NAME": "Case 1C",
'ICON_FILE': document.getElementById('type-icon'), // file input node
"IS_CONFIGURABLE_TYPE": "N"
}
}, result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
After this, you only need to specify your type when creating an activity, and the icon and name will be loaded automatically.
BX24.callMethod(
'crm.activity.add',
{
fields:
{
"OWNER_TYPE_ID": 1,
"OWNER_ID": selectedEntityId,
"PROVIDER_ID": 'REST_APP',
"PROVIDER_TYPE_ID": '1C',
"SUBJECT": "New case",
"COMPLETED": "N",
"RESPONSIBLE_ID": 1,
"DESCRIPTION": "Description of the new case"
}
}, result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.type.add',
[
'fields' => [
'TYPE_ID' => '1C',
'NAME' => 'Case 1C',
'ICON_FILE' => $_FILES['type-icon'], // Assuming file input is handled
'IS_CONFIGURABLE_TYPE' => 'N'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
After this, you only need to specify your type when creating an activity, and the icon and name will be loaded automatically.
require_once('crest.php');
$result = CRest::call(
'crm.activity.add',
[
'fields' => [
'OWNER_TYPE_ID' => 1,
'OWNER_ID' => $selectedEntityId, // Assuming this variable is defined
'PROVIDER_ID' => 'REST_APP',
'PROVIDER_TYPE_ID' => '1C',
'SUBJECT' => 'New case',
'COMPLETED' => 'N',
'RESPONSIBLE_ID' => 1,
'DESCRIPTION' => 'Description of the new case'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Example
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.activity.type.add(
fields={
"TYPE_ID": "CUSTOM_CALL",
"NAME": "Custom call",
"ICON_FILE": {
"fileData": [
"activity-type.svg",
"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPjwvc3ZnPg==",
],
},
"IS_CONFIGURABLE_TYPE": "N",
},
).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.type.add", b24.Params{
"fields": b24.Params{
"TYPE_ID": "1C",
"NAME": "Case 1C",
"ICON_FILE": "@type-icon",
"IS_CONFIGURABLE_TYPE": "N",
},
})
if err != nil {
return fmt.Errorf("crm.activity.type.add: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("done:", ok)
Response Handling
HTTP status: 200
{
"result": true,
"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. Contains:
|
|
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 |
|
|
The method works only in the context of applications |
|
|
The method is only available to administrators |
|
|
The required field |
|
|
A custom activity type with the specified |
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 |