метод REST scope: crm

crm.activity.type.add

Добавить пользовательский тип дела

Кто может выполнять: администратор

Описание

Метод crm.activity.type.add регистрирует пользовательский тип дела с указанием названия и иконки.

Параметры

fields object обязательный

Значения полей для добавления нового пользовательского типа дела в виде структуры:

fields:
{
    "TYPE_ID": 'значение',
    "NAME": 'значение',
    "ICON_FILE": 'значение',
    "IS_CONFIGURABLE_TYPE": 'значение',
}

Подробное описание приведено ниже

Параметр fields

TYPE_ID string обязательный

Строковое значение типа дела, например 1C. При создании дела это поле PROVIDER_TYPE_ID

NAME string необязательный

Название типа дела, например Дело 1с для сделки. По умолчанию пустая строка

ICON_FILE attached_diskfile необязательный

Файл иконки типа дела, описанный по правилам

IS_CONFIGURABLE_TYPE string необязательный

Значение по умолчанию - N. Значение Y - признак того, что тип будет использоваться для конфигурируемых дел

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TYPE_ID":"1C","NAME":"Дело 1C","ICON_FILE":"@type-icon","IS_CONFIGURABLE_TYPE":"N"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.type.add

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":"Новое дело","COMPLETED":"N","RESPONSIBLE_ID":1,"DESCRIPTION":"Описание нового дела"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.add

Ответ

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

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

result boolean

Корневой элемент ответа. Содержит:
- true — в случае успеха
- false — в случае неудачи (произошла ошибка)

time time

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
    "error": "NOT_FOUND",
    "error_description": "Not found."
}
Код Описание Значение
ACCESS_DENIED Недостаточно прав для выполнения операции
Access denied! Application context required Метод работает только в контексте приложений
Admin permissions required Метод доступен только администратору
INVALID_ARG_VALUE Не заполнено обязательное поле TYPE_ID
INVALID_ARG_VALUE Пользовательский тип дела с указанным TYPE_ID уже существует

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.