метод REST scope: crm

crm.category.update

Обновить воронку

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

Описание

Метод обновляет воронку (направление) с идентификатором id, задав ей новые значения полей из fields. Если какое-то поле будет отсутствовать в fields, то его значение останется неизменным.

Параметры

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

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

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

Идентификатор воронки. Можно получить методом crm.category.list или при создании воронки методом crm.category.add

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

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

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

Параметр fields

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

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

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

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

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

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

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

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

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

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

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

Узнать неизменяемое ли поле можно с помощью метода crm.category.fields. Неизменяемые поля имеют свойство isReadonly = true

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":1152,"id":4,"fields":{"name":"Новое название воронки","sort":1000,"isDefault":"Y"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.category.update

Ответ

HTTP-статус: 200

{
    "result": {
        "category": {
            "id": 4,
            "name": "Новое название воронки",
            "sort": 1000,
            "entityTypeId": 1152,
            "isDefault": "Y"
        }
    },
    "time": {
        "start": 1718359296.368324,
        "finish": 1718359296.65352,
        "duration": 0.28519606590270996,
        "processing": 0.03645014762878418,
        "date_start": "2024-06-14T12:01:36+02:00",
        "date_finish": "2024-06-14T12:01:36+02:00",
        "operating": 0
    }
}

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

result object

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

time time

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

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

HTTP-статус: 400

{
    "error": "NOT_FOUND",
    "error_description": "Смарт-процесс не найден"
}
Код Описание Значение
NOT_FOUND Смарт-процесс не найден Возникает при некорректных значениях entityTypeId
ENTITY_TYPE_NOT_SUPPORTED Entity type {entityTypeName} is not supported Возникает, если объект CRM не поддерживает воронки
NOT_FOUND Элемент не найден Возникает, если обновляемой воронки не существует
ACCESS_DENIED Доступ запрещен Возникает, если у пользователя, обновляющего воронку, недостаточно прав

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

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