Add System Activity crm.activity.add

Scope: crm

Who can execute the method: user with permission to add an activity

Method development has been halted

The method crm.activity.add continues to function, but there is a more relevant alternative crm.activity.todo.add.

The method crm.activity.add creates a new system activity.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
array

Array of values for activity fields in the following structure:

fields:
        {
            "OWNER_TYPE_ID": 2, 
            "OWNER_ID": 102, 
            "TYPE_ID": 2, 
            "SUBJECT": "New call",
        }
        

There is an additional field DISABLE_SENDING_MESSAGE_COPY. It is intended to forcibly disable sending a copy of the message to the recipient from MESSAGE_FROM. If the parameter is not filled or any value other than Y is specified, a copy will be sent. Example:

[
            'fields'=> array(
                'SETTINGS'=> array(
                    'DISABLE_SENDING_MESSAGE_COPY'=>'Y'
                )
            )
        ]
        

Parameter fields

Required parameters are marked with *

Field type

Description

OWNER_ID*
integer

Identifier of the CRM entity

OWNER_TYPE_ID*
integer

Identifier of the CRM object type

TYPE_ID*
crm_enum_activitytype

Type of the deal. To access the available deal types, use the method crm.enum.activitytype.

To create a deal with the type "task," use the method creation or modification of the task and specify the CRM entity in the field UF_CRM_TASK

ASSOCIATED_ENTITY_ID
integer

Identifier of the entity associated with the activity

COMMUNICATIONS*
crm_activity_communication

Description of communication

DEADLINE
datetime

Date and time of the activity deadline. The field is not set directly; the value is taken from START_TIME for calls and meetings and from END_TIME for tasks

DESCRIPTION
string

Text description of the activity

DESCRIPTION_TYPE
crm.enum.contenttype

Type of description

DIRECTION
crm.enum.activitydirection

Direction of the activity: incoming/outgoing. Relevant for calls and emails, not used for meetings

END_TIME
datetime

End time of the activity

FILES
diskfile

Files added to the activity

LOCATION
string

Location

NOTIFY_TYPE
crm.enum.activitynotifytype

Type of notification

ORIGINATOR_ID
string

Identifier of the data source, used only for binding to an external source

ORIGIN_ID
string

Identifier of the entity in the data source, used only for binding to an external source

ORIGIN_VERSION
string

Original version, used to protect data from accidental overwriting by an external system. If the data was imported and not changed in the external system, such data can be edited in CRM without fear that the next export will lead to data overwriting

PRIORITY
crm.enum.activitypriority

Priority

PROVIDER_DATA
string

Additional provider data

PROVIDER_GROUP_ID
string

Identifier of the provider group

PROVIDER_ID
string

Identifier of the provider

PROVIDER_TYPE_ID
string

Identifier of the provider type, status from the directory

PROVIDER_PARAMS
object

Additional provider parameters

RESPONSIBLE_ID*
user

Identifier of the user responsible for the activity

SETTINGS
object

Additional settings

START_TIME
datetime

Start time of the activity

STATUS
crm_enum_activitystatus

Status of the activity

SUBJECT
string

Additional description of the activity

WEBDAV_ELEMENTS
diskfile

Added files. Deprecated, kept for compatibility

IS_INCOMING_CHANNEL
char

Flag indicating whether the activity was created from an incoming channel (Y/N)

Value Usage Examples for Fields

For activities of type e-mail:

  • if the email should not be sent, set parameters DIRECTION=2 and COMPLETED='N';
  • if it is necessary to mark emails as completed, update the activities by setting the completion flag.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"OWNER_TYPE_ID":2,"OWNER_ID":102,"TYPE_ID":2,"COMMUNICATIONS":[{"VALUE":"+18005551234","ENTITY_ID":134,"ENTITY_TYPE_ID":3}],"SUBJECT":"New call","START_TIME":"2023-12-31T12:00:00+00:00","END_TIME":"2023-12-31T12:30:00+00:00","COMPLETED":"N","PRIORITY":3,"RESPONSIBLE_ID":1,"DESCRIPTION":"Important call","DESCRIPTION_TYPE":3,"DIRECTION":2,"FILES":[{"fileData":["example.jpg","base64_encoded_content_here"]}]} }' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"OWNER_TYPE_ID":2,"OWNER_ID":102,"TYPE_ID":2,"COMMUNICATIONS":[{"VALUE":"+18005551234","ENTITY_ID":134,"ENTITY_TYPE_ID":3}],"SUBJECT":"New call","START_TIME":"2023-12-31T12:00:00+00:00","END_TIME":"2023-12-31T12:30:00+00:00","COMPLETED":"N","PRIORITY":3,"RESPONSIBLE_ID":1,"DESCRIPTION":"Important call","DESCRIPTION_TYPE":3,"DIRECTION":2,"FILES":[{"fileData":["example.jpg","base64_encoded_content_here"]}]},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.activity.add
        
try
        {
        	const response = await $b24.callMethod(
        		"crm.activity.add",
        		{
        			fields: {
        				"OWNER_TYPE_ID": 2,
        				"OWNER_ID": 102,
        				"TYPE_ID": 2,
        				"COMMUNICATIONS": [
        					{ VALUE: "+18005551234", ENTITY_ID: 134, ENTITY_TYPE_ID: 3 }
        				],
        				"SUBJECT": "New call",
        				"START_TIME": "2023-12-31T12:00:00+00:00", // Example date and time
        				"END_TIME": "2023-12-31T12:30:00+00:00", // Example date and time
        				"COMPLETED": "N",
        				"PRIORITY": 3,
        				"RESPONSIBLE_ID": 1,
        				"DESCRIPTION": "Important call",
        				"DESCRIPTION_TYPE": 3,
        				"DIRECTION": 2,
        				"FILES": [
        					{
        						fileData: [
        							"example.jpg", // File name
        							"base64_encoded_content_here" // File content in base64 format
        						]
        					}
        				]
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.activity.add',
                    [
                        'fields' => [
                            'OWNER_TYPE_ID'    => 2,
                            'OWNER_ID'         => 102,
                            'TYPE_ID'          => 2,
                            'COMMUNICATIONS'   => [
                                ['VALUE' => '+18005551234', 'ENTITY_ID' => 134, 'ENTITY_TYPE_ID' => 3]
                            ],
                            'SUBJECT'          => 'New call',
                            'START_TIME'       => '2023-12-31T12:00:00+00:00',
                            'END_TIME'         => '2023-12-31T12:30:00+00:00',
                            'COMPLETED'        => 'N',
                            'PRIORITY'         => 3,
                            'RESPONSIBLE_ID'   => 1,
                            'DESCRIPTION'      => 'Important call',
                            'DESCRIPTION_TYPE' => 3,
                            'DIRECTION'        => 2,
                            'FILES'            => [
                                [
                                    'fileData' => [
                                        'example.jpg',
                                        'base64_encoded_content_here'
                                    ]
                                ]
                            ]
                        ]
                    ]
                );
        
            $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 activity: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.activity.add",
            {
                fields: {
                    "OWNER_TYPE_ID": 2,
                    "OWNER_ID": 102,
                    "TYPE_ID": 2,
                    "COMMUNICATIONS": [
                        { VALUE: "+18005551234", ENTITY_ID: 134, ENTITY_TYPE_ID: 3 }
                    ],
                    "SUBJECT": "New call",
                    "START_TIME": "2023-12-31T12:00:00+00:00", // Example date and time
                    "END_TIME": "2023-12-31T12:30:00+00:00", // Example date and time
                    "COMPLETED": "N",
                    "PRIORITY": 3,
                    "RESPONSIBLE_ID": 1,
                    "DESCRIPTION": "Important call",
                    "DESCRIPTION_TYPE": 3,
                    "DIRECTION": 2,
                    "FILES": [
                        {
                            fileData: [
                                "example.jpg", // File name
                                "base64_encoded_content_here" // File content in base64 format
                            ]
                        }
                    ]
                }
            },
            result => {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.dir(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.activity.add',
            [
                'fields' => [
                    'OWNER_TYPE_ID' => 2,
                    'OWNER_ID' => 102,
                    'TYPE_ID' => 2,
                    'COMMUNICATIONS' => [
                        [
                            'VALUE' => '+18005551234',
                            'ENTITY_ID' => 134,
                            'ENTITY_TYPE_ID' => 3
                        ]
                    ],
                    'SUBJECT' => 'New call',
                    'START_TIME' => '2023-12-31T12:00:00+00:00', // Example date and time
                    'END_TIME' => '2023-12-31T12:30:00+00:00', // Example date and time
                    'COMPLETED' => 'N',
                    'PRIORITY' => 3,
                    'RESPONSIBLE_ID' => 1,
                    'DESCRIPTION' => 'Important call',
                    'DESCRIPTION_TYPE' => 3,
                    'DIRECTION' => 2,
                    'FILES' => [
                        [
                            'fileData' => [
                                'example.jpg', // File name
                                'base64_encoded_content_here' // File content in base64 format
                            ]
                        ]
                    ]
                ]
            ]
        );
        
        if (isset($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo '<PRE>';
            print_r($result['result']);
            echo '</PRE>';
        }
        

Response Handling

HTTP status: 200

{
            "result": 999,
            "time": {
                "start": 1712132792.910734,
                "finish": 1712132793.530359,
                "duration": 0.6196250915527344,
                "processing": 0.032338857650756836,
                "date_start": "2024-04-03T10:26:32+02:00",
                "date_finish": "2024-04-03T10:26:33+02:00",
                "operating_reset_at": 1705765533,
                "operating": 3.3076241016387939
            }
        }
        

Returned Data

Name
type

Description

result
boolean

Result of the operation. Returns the identifier of the activity in the timeline in case of success, otherwise — false

time
time

Information about the execution time of the request

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "Access denied."
        }
        

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

The field SUBJECT is not defined or empty

The SUBJECT field is not set

The field RESPONSIBLE_ID is not defined or invalid

The RESPONSIBLE_ID field is not set

The field TYPE_ID is not defined or invalid

The TYPE_ID field is not set

The field COMMUNICATIONS is not defined or invalid

The COMMUNICATIONS field is not set

The only one communication is allowed for activity of specified type

More than one contact is specified

Could not build binding. Please ensure that owner info and communications are defined correctly

Connections for the activity are not specified

  • Email send error. Failed to load module "subscribe"
  • Email send error. Invalid data
  • Email send error. Invalid email is specified
  • Email send error. "From" is not found
  • Email send error. "To" is not found
  • Email send error. Failed to add posting. Please see details below
  • Email send error. Failed to save posting file. Please see details below
  • Email send error. Failed to update activity
  • Email send error. General error

Errors related to "email" activities

The custom activity without provider is not supported in current context

Activity type is not supported in the specified context

Use crm.activity.configurable.add for this activity provider

Incorrect method call for configurable activity

Access denied

No permission to add an entity in CRM

Application context required

Incorrect PROVIDER_ID parameter for the activity created in the application context

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