Блог Горошко Андрея Bitrix24,PHP Обновить воронку crm.category.update

Обновить воронку crm.category.update

Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Обновить воронку crm.category.update». Вы узнаете экспертные методики работы с crm.category.update и научитесь избегать типичных ошибок начинающих разработчиков.

Обновить воронку crm.category.update

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

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

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

Название
тип
Описание
entityTypeId
[integer][1]
Идентификатор системного или пользовательского типа сущностей CRM у которого будет обновлена воронка
id
[integer][1]
Идентификатор воронки. Можно получить методом crm.category.list или при создании воронки методом crm.category.add
fields*
[object][1]
Значения полей (подробное описание приведено ниже) для обновления полей воронки в виде структуры:

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

Параметр fields

Название
тип
Описание
name
[string][1]
Название воронки. Каким может быть название:
— длина не может быть больше 255 символов
— не может быть пустым
— не может состоять только лишь из пробелов, табов и так далее

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

sort
[integer][1]
Индекс сортировки.

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

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

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

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

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

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

Примеры кода

Как обновить воронку с id = 4 в смарт-процессе с entityTypeId = 1152

  • cURL (Webhook)
    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
  • cURL (OAuth)
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"entityTypeId":1152,"id":4,"fields":{"name":"Новое название воронки","sort":1000,"isDefault":"Y"},"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/crm.category.update
  • JS
    try
    {
    	const response = await $b24.callMethod(
    		"crm.category.update",
    		{
    			entityTypeId: 1152,
    			id: 4,
    			fields: {
    				name: "Новое название воронки",
    				sort: 1000,
    				isDefault: "Y",
    			},
    		}
    	);
    	
    	const result = response.getData().result;
    	console.info(result);
    }
    catch( error )
    {
    	console.error(error);
    }
  • PHP
    try {
        $response = $b24Service
            ->core
            ->call(
                'crm.category.update',
                [
                    'entityTypeId' => 1152,
                    'id'          => 4,
                    'fields'      => [
                        'name'     => 'Новое название воронки',
                        'sort'     => 1000,
                        'isDefault' => 'Y',
                    ],
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
        // Нужная вам логика обработки данных
        processData($result);
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error updating category: ' . $e->getMessage();
    }
  • BX24.js
    BX24.callMethod(
        "crm.category.update",
        {
            entityTypeId: 1152,
            id: 4,
            fields: {
                name: "Новое название воронки",
                sort: 1000,
                isDefault: "Y",
            },
        },
        (result) => 
        {
            if (result.error())
            {
                console.error(result.error());
            }
            else
            {
                console.info(result.data());
            }
        }
    );
  • PHP CRest
    require_once('crest.php');

    $result = CRest::call(
        'crm.category.update',
        [
            'entityTypeId' => 1152,
            'id' => 4,
            'fields' => [
                'name' => "Новое название воронки",
                'sort' => 1000,
                'isDefault' => "Y"
            ]
        ]
    );

    echo '<PRE>';
    print_r($result);
    echo '</PRE>';

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

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_SUPPORTEDEntity type {entityTypeName} is not supportedВозникает, если объект CRM не поддерживает воронки
NOT_FOUNDЭлемент не найденВозникает, если обновляемой воронки не существует
ACCESS_DENIEDДоступ запрещенВозникает, если у пользователя, обновляющего воронку, недостаточно прав
  • [](./crm-category-add)
  • [](./crm-category-get)
  • [](./crm-category-list)
  • [](./crm-category-delete)
  • [](./crm-category-fields)

[1]: ../../../data-types.md

💡 Экспертное мнение и рекомендации

Ключевые выводы по теме «Обновить воронку crm.category.update»:

Использование современных стандартов D7 при работе с crm.category.update позволяет писать чистый, масштабируемый и безопасный код. Не забывайте обрабатывать исключения (try/catch) и проверять права доступа текущего пользователя перед выполнением критических операций.

Похожая задача в бизнесе?

Помогу автоматизировать процессы и внедрить ИИ

Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.

Related Post

Как использовать метод SDK task.commentitem.delete в Битрикс24Как использовать метод SDK task.commentitem.delete в Битрикс24

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Как использовать метод SDK task.commentitem.delete в Битрикс24», проанализируем

Обновить свойство отгрузки sale.shipmentproperty.updateОбновить свойство отгрузки sale.shipmentproperty.update

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Обновить свойство отгрузки sale.shipmentproperty.update», проанализируем лучшие практики и

Коробочная версия Битрикс24 (On-Premise): цены, редакции и системные требованияКоробочная версия Битрикс24 (On-Premise): цены, редакции и системные требования

Выбор редакции, расчет точной сметы и покупка официальных лицензий 1С-Битрикс и Битрикс24 — это ключевой этап планирования любого цифрового проекта. Информация по теме «Коробочная версия Битрикс24 (On-Premise): цены, редакции и