метод REST scope: crm

crm.category.add

Добавить новую воронку

Кто может выполнять: любой пользователь с административным доступом к разделу CRM

Описание

Метод создает у типа объекта CRM с идентификатором entityTypeId новую воронку (направление).

Параметры

entityTypeId integer обязательный

Идентификатор системного или пользовательского типа сущности CRM для которой будет создана новая воронка

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

Значения полей (подробное описание приведено ниже) для добавления новой воронки в виде структуры:

fields: {
    name: "значение",
    sort: "значение",
    isDefault: "значение",
},

Параметр fields

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

Название воронки. Каким может быть название:
- длина не может быть больше 255 символов
- не может быть пустым
- не может состоять только лишь из пробелов, табов и так далее

По умолчанию равно -

sort integer необязательный

Индекс сортировки.

Не может быть отрицательным. Если передать в sort значение меньше нуля, оно будет проигнорировано и выставиться sort = 0

По умолчанию имеет значение 500

isDefault boolean необязательный

Является ли воронка, воронкой по умолчанию. Может иметь значения:
- Y — да, является
- N — нет

По умолчанию равно N.

В сделках поле isDefault недоступно для изменения.

Ограничения на изменение поля isDefault в смарт-процессах:
- нельзя удалить направление по умолчанию,
- при создании нового направления и передаче ему флага isDefault: "Y", старое направление по умолчанию перестанет быть направлением по умолчанию,
- при изменении направления по умолчанию нельзя сделать его направлением не по умолчанию,
- при изменении направления не по умолчанию с передачей ему флага isDefault: "Y" старое направление по умолчанию перестанет быть направлением по умолчанию.

Если для имеющегося смарт-процесса отключен показ направлений в интерфейсе, то работа с направлениями через rest все равно возможна

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId": 1152, "fields": {"name": "Новая воронка по умолчанию", "sort": 50, "isDefault": "Y"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.category.add

Ответ

HTTP-статус: 200

{
    "result": {
        "category": {
            "id": 5,
            "name": "Новая воронка по умолчанию",
            "sort": 50,
            "entityTypeId": 1152,
            "isDefault": "Y"
        }
    },
    "time": {
        "start": 1718116794.208887,
        "finish": 1718116794.666272,
        "duration": 0.4573848247528076,
        "processing": 0.1496260166168213,
        "date_start": "2024-06-11T16:39:54+02:00",
        "date_finish": "2024-06-11T16:39:54+02:00",
        "operating": 0
    }
}

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

result object

Корневой элемент ответа. Содержит объект category с информацией о воронке

time object

Объект, содержащий в себе информацию о времени выполнения запроса

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

HTTP-статус: 160

{
    "error": "NOT_FOUND", 
    "error_description": "Смарт-процесс не найден"
}
Код Описание Значение
NOT_FOUND Смарт-процесс не найден Возникает при некорректных значениях entityTypeId
ENTITY_TYPE_NOT_SUPPORTED Entity type {entityTypeName} is not supported Возникает, если объект CRM не поддерживает воронки
ADDING_DISABLED Добавление системной категории запрещено Возникает при попытке создать системную воронку в смарт-процессах
ACCESS_DENIED Доступ запрещен Возникает, если у пользователя недостаточно прав для добавления воронки
0 Field 'NAME' is required Возникает, если не передано обязательное поле name
0 Default client category does not support updating default state Возникает при попытке создать воронку по умолчанию для контактов или компаний

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

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