Добавить универсальное дело crm.activity.todo.add

Scope: crm

Кто может выполнять метод: пользователь с правом на редактирование элемента CRM, для которого дабавляется дело

Метод crm.activity.todo.add добавляет универсальное дело в таймлайн.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
ownerTypeId* `integer`	Идентификатор типа объекта CRM, к которому привязано дело, например `2` для сделки
ownerId* `integer`	Идентификатор элемента CRM, к которому привязано дело, например, `1`
deadline* `datetime`	Крайний срок дела, например `2025-02-03T15:00:00`
title `string`	Название дела, по умолчанию пустая строка
description `string`	Описание дела, по умолчанию пустая строка
responsibleId `integer`	Идентификатор пользователя, ответственного за дело, например `1`
parentActivityId `integer`	Идентификатор дела в таймлайне, с которым можно связать создаваемое дело, например `888`
pingOffsets `array`	Массив, который содержит целочисленные значения в минутах, позволяющие настроить время напоминания о деле. Например `[0, 15]` означает, что будет создано 2 напоминания, которые придут за 15 минут до крайнего срока и в момент, когда крайний срок наступит. По умолчанию пустой массив, без напоминаний
colorId `string`	Идентификатор цвета дела в таймлайне, например `1`. Для выбора доступно 8 цветов, значения от 1 до 7 и цвет по умолчанию, если ничего не указано:

Примеры кода

Как использовать примеры в документации

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":"Заголовок дела","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":"Заголовок дела","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: 'Заголовок дела',
        			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'         => 'Заголовок дела',
                        'description'   => 'Описание дела',
                        'responsibleId' => 5,
                        'pingOffsets'   => [0, 15],
                        'colorId'       => '2'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            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: 'Заголовок дела',
                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'), // Текущие дата и время в формате ISO 8601
                'title' => 'Заголовок дела',
                'description' => 'Описание дела',
                'responsibleId' => 5,
                'pingOffsets' => [0, 15],
                'colorId' => '2'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 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
            }
        }

Возвращаемые данные

Название `тип`	Описание
result `object`	В случае успеха возвращает объект, содержащий идентификатор добавленного дела `id`, в случае ошибки = `null`
time `time`	Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

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

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание
`100`	Не переданы обязательные поля
`NOT_FOUND`	Элемент CRM не найден
`ACCESS_DENIED`	Недостаточно прав для выполнения операции
`OWNER_NOT_FOUND`	Владелец элемента не найден
`WRONG_DATETIME_FORMAT`	Некорректный формат даты

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Обзор методов

Обновить универсальное дело

Добавить универсальное дело crm.activity.todo.add

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение