Add Universal Activity crm.activity.todo.add

Scope: crm

Who can execute the method: a user with permission to edit the CRM entity to which the activity is being added.

The method crm.activity.todo.add adds a universal activity to the timeline.

Method Parameters

Required parameters are marked with *

Name `type`	Description
ownerTypeId* `integer`	Identifier of the CRM object type to which the activity is linked, for example `2` for a deal
ownerId* `integer`	Identifier of the CRM entity to which the activity is linked, for example, `1`
deadline* `datetime`	Deadline for the activity, for example `2025-02-03T15:00:00`
title `string`	Title of the activity, default is an empty string
description `string`	Description of the activity, default is an empty string
responsibleId `integer`	Identifier of the user responsible for the activity, for example `1`
parentActivityId `integer`	Identifier of the activity in the timeline with which the created activity can be linked, for example `888`
pingOffsets `array`	An array containing integer values in minutes that allow you to set reminder times for the activity. For example, `[0, 15]` means that 2 reminders will be created, one 15 minutes before the deadline and one at the moment the deadline occurs. Default is an empty array, with no reminders
colorId `string`	Identifier of the activity color in the timeline, for example `1`. There are 8 colors available, values from 1 to 7 and a default color if none is specified:

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ownerTypeId":2,"ownerId":1,"deadline":"'"$(date -Iseconds)"'","title":"Activity Title","description":"Activity Description","responsibleId":5,"pingOffsets":[0,15],"colorId":"2"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.todo.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ownerTypeId":2,"ownerId":1,"deadline":"'"$(date -Iseconds)"'","title":"Activity Title","description":"Activity Description","responsibleId":5,"pingOffsets":[0,15],"colorId":"2","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.activity.todo.add

try
        {
        	const response = await $b24.callMethod(
        		'crm.activity.todo.add',
        		{
        			ownerTypeId: 2,
        			ownerId: 1,
        			deadline: (new Date()),
        			title: 'Activity Title',
        			description: 'Activity Description',
        			responsibleId: 5,
        			pingOffsets: [0, 15],
        			colorId: '2'
        		}
        	);
        	
        	const result = response.getData().result;
        	if (result.error())
        	{
        		console.error(result.error());
        	}
        	else
        	{
        		console.dir(result);
        	}
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.activity.todo.add',
                    [
                        'ownerTypeId'   => 2,
                        'ownerId'       => 1,
                        'deadline'      => (new DateTime()),
                        'title'         => 'Activity Title',
                        'description'   => 'Activity Description',
                        'responsibleId' => 5,
                        'pingOffsets'   => [0, 15],
                        'colorId'       => '2'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your data processing logic
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding todo activity: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.activity.todo.add",
            {
                ownerTypeId: 2,
                ownerId: 1,
                deadline: (new Date()),
                title: 'Activity Title',
                description: 'Activity Description',
                responsibleId: 5,
                pingOffsets: [0, 15],
                colorId: '2'
            }, 
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.activity.todo.add',
            [
                'ownerTypeId' => 2,
                'ownerId' => 1,
                'deadline' => date('c'), // Current date and time in ISO 8601 format
                'title' => 'Activity Title',
                'description' => 'Activity Description',
                'responsibleId' => 5,
                'pingOffsets' => [0, 15],
                'colorId' => '2'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "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`	On success, returns an object containing the identifier of the added activity `id`, on error = `null`
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
`100`	Required fields are missing
`NOT_FOUND`	CRM entity not found
`ACCESS_DENIED`	Insufficient permissions to perform the operation
`OWNER_NOT_FOUND`	Owner of the entity not found
`WRONG_DATETIME_FORMAT`	Incorrect date format

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

Update Universal Activity

Add Universal Activity crm.activity.todo.add

Method ParametersMethod Parameters

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