Add Custom Activity Type crm.activity.type.add

Scope: crm

Who can execute the method: any user

The method crm.activity.type.add registers a custom activity type by specifying a name and an icon.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

Field values for adding a new custom activity type in the form of a structure:

fields:
        {
            "TYPE_ID": 'value',
            "NAME": 'value',
            "ICON_FILE": 'value',
            "IS_CONFIGURABLE_TYPE": 'value',
        }

A detailed description is provided below

Parameter fields

Required parameters are marked with *

Name `type`	Description
TYPE_ID* `string`	String value of the activity type, for example `QuickBooks and other similar platforms`. When creating an activity, this field is `PROVIDER_TYPE_ID`
NAME `string`	Name of the activity type, for example `Activity for QuickBooks` for a deal. Default is an empty string
ICON_FILE `attached_diskfile`	Icon file for the activity type, described according to rules
IS_CONFIGURABLE_TYPE `string`	Default value is `N`. Value `Y` indicates that the type will be used for configurable activities

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"TYPE_ID":"QuickBooks and other similar platforms","NAME":"Activity for QuickBooks","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, it is sufficient 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":"QuickBooks and other similar platforms","SUBJECT":"New Activity","COMPLETED":"N","RESPONSIBLE_ID":1,"DESCRIPTION":"Description of the new activity"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.activity.add

try
        {
        	const response = await $b24.callMethod(
        		"crm.activity.type.add",
        		{
        			fields:
        			{
        				"TYPE_ID": 'QuickBooks and other similar platforms',
        				"NAME": "Activity for QuickBooks",
        				'ICON_FILE': document.getElementById('type-icon'), // file input node
        				"IS_CONFIGURABLE_TYPE": "N"
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.activity.type.add',
                    [
                        'fields' => [
                            'TYPE_ID'            => 'QuickBooks and other similar platforms',
                            'NAME'               => 'Activity for QuickBooks',
                            '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": 'QuickBooks and other similar platforms',
                    "NAME": "Activity for QuickBooks",
                    '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, it is sufficient 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": 'QuickBooks and other similar platforms',
                    "SUBJECT": "New Activity",
                    "COMPLETED": "N",
                    "RESPONSIBLE_ID": 1,
                    "DESCRIPTION": "Description of the new activity"
                }
            }, 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' => 'QuickBooks and other similar platforms',
                    'NAME' => 'Activity for QuickBooks',
                    'ICON_FILE' => $_FILES['type-icon'], // Assuming file input is handled
                    'IS_CONFIGURABLE_TYPE' => 'N'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

After this, it is sufficient 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' => 'QuickBooks and other similar platforms',
                   'SUBJECT' => 'New Activity',
                   'COMPLETED' => 'N',
                   'RESPONSIBLE_ID' => 1,
                   'DESCRIPTION' => 'Description of the new activity'
               ]
           ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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
type

Description

result
boolean

Root element of the response. Contains:

true — in case of success
false — in case of failure (an error occurred)

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "NOT_FOUND",
            "error_description": "Not found."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `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
`ACCESS_DENIED`	Insufficient permissions to perform the operation
`Access denied! Application context required`	The method works only in the context of applications
`INVALID_ARG_VALUE`	The required field `TYPE_ID` is not filled
`INVALID_ARG_VALUE`	A custom activity type with the specified `TYPE_ID` already exists

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Get List of Custom Types

Add Custom Activity Type crm.activity.type.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

Parameter fields

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning