Обновить пользовательский тип crm.type.update

Scope: crm

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

Метод обновляет существующий смарт-процесс по его идентификатору id.

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

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

Параметр fieldsПараметр fields

{
            "id": 128,
            "fields": {
                "isDocumentsEnabled": "N"
            }
        }
        

СвязиСвязи

• Настройки необходимо передавать целиком, они полностью перезаписываются.
• Нельзя изменить настройки предустановленных связей (iPredefined: true). Эти настройки можно не передавать в запросе.
• Если при попытке сохранить переданные настройки связей возникнет ошибка, она не будет выведена. Настройки просто не сохранятся.

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

1. У смарт-процесса с id = 20:

   • Отключить следующие настройки:
     • Роботы и триггеры
     • Поля Дата начала и Дата завершения
     • Поле Клиент
     • Поле Наблюдатели
   • Включить следующие настройки:
     • Поля Источник и Дополнительно об источнике
     • Использование своих стадий и канбана
   • Включить отображение смарт-процесса в поле Задачи
   cURL (Webhook)

   cURL (OAuth)

   JS

   PHP

   curl -X POST \
           -H "Content-Type: application/json" \
           -H "Accept: application/json" \
           -d '{"id":20,"fields":{"isAutomationEnabled":"N","isBeginCloseDatesEnabled":"N","isClientEnabled":"N","isObserversEnabled":"N","isSourceEnabled":"Y","isStagesEnabled":"Y","isUseInUserfieldEnabled":"Y","linkedUserFields":{"TASKS_TASK|UF_CRM_TASK":"true"}}}' \
           https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.type.update
           

   curl -X POST \
           -H "Content-Type: application/json" \
           -H "Accept: application/json" \
           -d '{"id":20,"fields":{"isAutomationEnabled":"N","isBeginCloseDatesEnabled":"N","isClientEnabled":"N","isObserversEnabled":"N","isSourceEnabled":"Y","isStagesEnabled":"Y","isUseInUserfieldEnabled":"Y","linkedUserFields":{"TASKS_TASK|UF_CRM_TASK":"true"}},"auth":"**put_access_token_here**"}' \
           https://**put_your_bitrix24_address**/rest/crm.type.update
           

   BX24.callMethod(
               'crm.type.update',
               {
                   id: 20,
                   fields: {
                       isAutomationEnabled: "N",
                       isBeginCloseDatesEnabled: "N",
                       isClientEnabled: "N",
                       isObserversEnabled: "N",
                       isSourceEnabled: "Y",
                       isStagesEnabled: "Y",
                       isUseInUserfieldEnabled: "Y",
                       linkedUserFields: {
                           "TASKS_TASK|UF_CRM_TASK": "true",
                       },
                   },
               },
               (result) => {
                   if (result.error())
                   {
                       console.error(result.error());
           
                       return;
                   }
           
                   console.info(result.data());
               },
           );
           

   require_once('crest.php');
           
           $result = CRest::call(
               'crm.type.update',
               [
                   'id' => 20,
                   'fields' => [
                       'isAutomationEnabled' => "N",
                       'isBeginCloseDatesEnabled' => "N",
                       'isClientEnabled' => "N",
                       'isObserversEnabled' => "N",
                       'isSourceEnabled' => "Y",
                       'isStagesEnabled' => "Y",
                       'isUseInUserfieldEnabled' => "Y",
                       'linkedUserFields' => [
                           "TASKS_TASK|UF_CRM_TASK" => "true",
                       ],
                   ]
               ]
           );
           
           echo '<PRE>';
           print_r($result);
           echo '</PRE>';
           

2. Допустим, у смарт-процесса с id = 20 необходимо

   • Удалить все привязанные к смарт-процессу сущности (relations.parent)
   • Включить «показ в карточке» для Лидов, к которым привязан смарт-процесс

   Исходные relations в смарт-процессе:

   {
               "relations": {
                   "parent": [
                       {
                           "entityTypeId": 31,
                           "isChildrenListEnabled": "N",
                           "isPredefined": "N"
                       }
                   ],
                   "child": [
                       {
                           "entityTypeId": 1,
                           "isChildrenListEnabled": "N",
                           "isPredefined": "N"
                       },
                       {
                           "entityTypeId": 2,
                           "isChildrenListEnabled": "N",
                           "isPredefined": "N"
                       }
                   ]
               }
           }
           

   Итоговый запрос:

   cURL (Webhook)

   cURL (OAuth)

   JS

   PHP

   curl -X POST \
           -H "Content-Type: application/json" \
           -H "Accept: application/json" \
           -d '{"id":20,"fields":{"relations":{"parent":[],"child":[{"entityTypeId":1,"isChildrenListEnabled":"true"},{"entityTypeId":2,"isChildrenListEnabled":"false"}]}}}' \
           https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.type.update
           

   curl -X POST \
           -H "Content-Type: application/json" \
           -H "Accept: application/json" \
           -d '{"id":20,"fields":{"relations":{"parent":[],"child":[{"entityTypeId":1,"isChildrenListEnabled":"true"},{"entityTypeId":2,"isChildrenListEnabled":"false"}]}},"auth":"**put_access_token_here**"}' \
           https://**put_your_bitrix24_address**/rest/crm.type.update
           

   BX24.callMethod(
               'crm.type.update',
               {
                   id: 20,
                   fields: {
                       relations: {
                           parent: [],
                           child: [
                               {
                                   "entityTypeId": 1,
                                   "isChildrenListEnabled": "true",
                               },
                               {
                                   "entityTypeId": 2,
                                   "isChildrenListEnabled": "false",
                               }
                           ],
                       },
                   },
               },
               (result) => {
                   if (result.error())
                   {
                       console.error(result.error());
           
                       return;
                   }
           
                   console.info(result.data());
               },
           );
           

   require_once('crest.php');
           
           $result = CRest::call(
               'crm.type.update',
               [
                   'id' => 20,
                   'fields' => [
                       'relations' => [
                           'parent' => [],
                           'child' => [
                               [
                                   "entityTypeId" => 1,
                                   "isChildrenListEnabled" => "true",
                               ],
                               [
                                   "entityTypeId" => 2,
                                   "isChildrenListEnabled" => "false",
                               ]
                           ],
                       ],
                   ]
               ]
           );
           
           echo '<PRE>';
           print_r($result);
           echo '</PRE>';
           

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

HTTP-статус: 200

{
            "result": {
                "type": {
                    "id": 20,
                    "title": "Смарт-процесс #3",
                    "code": "",
                    "createdBy": 1,
                    "entityTypeId": 1222,
                    "customSectionId": null,
                    "isCategoriesEnabled": "Y",
                    "isStagesEnabled": "Y",
                    "isBeginCloseDatesEnabled": "N",
                    "isClientEnabled": "N",
                    "isUseInUserfieldEnabled": "Y",
                    "isLinkWithProductsEnabled": "N",
                    "isMycompanyEnabled": "Y",
                    "isDocumentsEnabled": "N",
                    "isSourceEnabled": "Y",
                    "isObserversEnabled": "N",
                    "isRecyclebinEnabled": "N",
                    "isAutomationEnabled": "N",
                    "isBizProcEnabled": "N",
                    "isSetOpenPermissions": "Y",
                    "isPaymentsEnabled": "N",
                    "isCountersEnabled": "N",
                    "createdTime": "2024-07-08T17:24:47+02:00",
                    "updatedTime": "2024-07-09T20:55:37+02:00",
                    "updatedBy": 1,
                    "relations": {
                        "parent": [],
                        "child": [
                            {
                                "entityTypeId": 1,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "N"
                            },
                            {
                                "entityTypeId": 2,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "N"
                            }
                        ]
                    },
                    "linkedUserFields": {
                        "CALENDAR_EVENT|UF_CRM_CAL_EVENT": "N",
                        "TASKS_TASK|UF_CRM_TASK": "Y",
                        "TASKS_TASK_TEMPLATE|UF_CRM_TASK": "N"
                    },
                    "customSections": []
                }
            },
            "time": {
                "start": 1720551426.116454,
                "finish": 1720551426.816224,
                "duration": 0.6997702121734619,
                "processing": 0.20451998710632324,
                "date_start": "2024-07-09T20:57:06+02:00",
                "date_finish": "2024-07-09T20:57:06+02:00",
                "operating": 0.2044668197631836
            }
        }
        

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

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

HTTP-статус: 400

{
            "error": 0,
            "error_description": "Смарт-процесс не найден"
        }
        

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

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

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

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

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

• Смарт-процессы: обзор методов
• Создать новый пользовательский тип crm.type.add
• Получить пользовательский тип по id crm.type.get
• Получить пользовательский тип по entityTypeId crm.type.getByEntityTypeId
• Получить список пользовательских типов crm.type.list
• Удалить пользовательский тип crm.type.delete
• Получить поля пользовательского типа crm.type.fields