Создать новый пользовательский тип crm.type.add

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

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

Метод создает новый смарт-процесс.

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

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

Название `тип`	Описание
fields* `object`	Значения полей (подробное описание приведено ниже) для добавления нового смарт-процесса

Параметр fields

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

Название `тип`	Описание	По умолчанию
title* `string`	Название смарт-процесса
entityTypeId `integer`	Идентификатор создаваемого смарт-процесса. Если не передавать данное поле, то оно будет сгенерировано автоматически. Стоит учитывать, что: Данный параметр является уникальны. Не получится создать два смарт-процесса с одинаковыми `entityTypeId` Значение `entityTypeId` обязано быть в одном из двух диапазонов: четным целым числом, которое больше или равно 1030 в диапазоне от 128 до 192
relations `object`	Объект, содержащий в себе связи к другим сущностям CRM. Структура описана ниже
isUseInUserfieldEnabled `boolean`	Включено ли использование смарт-процесса в пользовательском поле	`N`
linkedUserFields `object`	Набор пользовательских полей в которых должен отображаться данный смарт-процесс. Структура описана ниже	`{}`
isAutomationEnabled `boolean`	Включены ли роботы и триггеры	`N`
isBeginCloseDatesEnabled `boolean`	Включены ли поля Дата начала и Дата завершения	`N`
isBizProcEnabled `boolean`	Включено ли использование дизайнера бизнес процессов	`N`
isCategoriesEnabled `boolean`	Включены ли свои воронки и туннели продаж	`N`
isClientEnabled `boolean`	Включено ли поле Клиент. При включенной опции у смарт-процесса появляется предустановленная привязка к Контактам и Компаниям	`N`
isDocumentsEnabled `boolean`	Включена ли печать документов	`N`
isLinkWithProductsEnabled `boolean`	Включена ли привязка товаров каталога	`N`
isMycompanyEnabled `boolean`	Включено ли поле Реквизиты вашей компании	`N`
isObserversEnabled `boolean`	Включено ли поле Наблюдатели	`N`
isRecyclebinEnabled `boolean`	Включено ли использование корзины	`N`
isSetOpenPermissions `boolean`	Делать ли новые воронки доступными для всех	`Y`
isSourceEnabled `boolean`	Включены ли поля Источник и Дополнительно об источнике	`N`
isStagesEnabled `boolean`	Включено ли использование своих стадий и канбана	`N`
isExternal `boolean`	Является ли смарт-процесс вынесенным из CRM (привязанным к цифровому рабочему месту) Параметр устарел. Для работы с цифровыми рабочими местами используйте методы `crm.automatedsolution.*`	`-`
customSectionId `integer`	Идентификатор цифрового рабочего места Параметр устарел. Для работы с цифровыми рабочими местами используйте методы `crm.automatedsolution.*`	`-`
customSections `array`	Массив цифровых рабочих мест Параметр устарел. Для работы с цифровыми рабочими местами используйте методы `crm.automatedsolution.*`	`-`

Связи relations

Название `тип`	Описание
parent `relation[]`	Элементы CRM, которые будут привязаны к данному смарт-процессу
child `relation[]`	Элементы CRM, к котором будет привязан данный смарт-процесс

Одна связь relation

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

Название
тип

Описание

По умолчанию

entityTypeId*
integer

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

-

isChildrenListEnabled
boolean

Добавлять ли связанный элемент в карточку.

Значения Y и N не работают. Необходимо передавать "true" или "false"

"false"

Привязка к пользовательским полям

linkedUserFields — набор полей, в которых должен отображаться этот смарт-процесс.
Данная настройка будет учитываться, только в случае передачи isUseInUserfieldEnabled = 'Y'

Название `тип`	Описание	Значение по умолчанию
CALENDAR_EVENT\|UF_CRM_CAL_EVENT `boolean`	Событие в календаре	`"false"`
TASKS_TASK\|UF_CRM_TASK `boolean`	Задачи	`"false"`
TASKS_TASK\|UF_CRM_TASK `boolean`	Шаблоны задач	`"false"`

Данные параметры не поддерживают передачу в них значений Y и N. Используйте "true" или "false".

Примеры кода

Как использовать примеры в документации

Создадим смарт-процесс со следующими условиями:

Наиболее полное количество включенных настроек
Привязать Лиды, Сделки, Счета к создаваемому смарт-процессу. Каждую из привязок добавляем в карточку элементов данного смарт-процесса
Привязать создаваемый смарт-процесс к Контактам и Компаниям. Привязку к Контактам добавляем в карточку
Смарт-процесс должен отображаться в следующих полях: Событие в календаре, Задачи

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"title":"Смарт-процесс","entityTypeId":2024,"isAutomationEnabled":"Y","isBeginCloseDatesEnabled":"Y","isBizProcEnabled":"Y","isCategoriesEnabled":"Y","isClientEnabled":"Y","isDocumentsEnabled":"Y","isLinkWithProductsEnabled":"Y","isMycompanyEnabled":"Y","isObserversEnabled":"Y","isRecyclebinEnabled":"Y","isSetOpenPermissions":"Y","isSourceEnabled":"Y","isStagesEnabled":"Y","isUseInUserfieldEnabled":"Y","linkedUserFields":{"CALENDAR_EVENT|UF_CRM_CAL_EVENT":"true","TASKS_TASK|UF_CRM_TASK":"true"},"relations":{"parent":[{"entityTypeId":1,"isChildrenListEnabled":"true"},{"entityTypeId":2,"isChildrenListEnabled":"true"},{"entityTypeId":31,"isChildrenListEnabled":"true"}],"child":[{"entityTypeId":3,"isChildrenListEnabled":"true"},{"entityTypeId":4}]}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.type.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"title":"Смарт-процесс","entityTypeId":2024,"isAutomationEnabled":"Y","isBeginCloseDatesEnabled":"Y","isBizProcEnabled":"Y","isCategoriesEnabled":"Y","isClientEnabled":"Y","isDocumentsEnabled":"Y","isLinkWithProductsEnabled":"Y","isMycompanyEnabled":"Y","isObserversEnabled":"Y","isRecyclebinEnabled":"Y","isSetOpenPermissions":"Y","isSourceEnabled":"Y","isStagesEnabled":"Y","isUseInUserfieldEnabled":"Y","linkedUserFields":{"CALENDAR_EVENT|UF_CRM_CAL_EVENT":"true","TASKS_TASK|UF_CRM_TASK":"true"},"relations":{"parent":[{"entityTypeId":1,"isChildrenListEnabled":"true"},{"entityTypeId":2,"isChildrenListEnabled":"true"},{"entityTypeId":31,"isChildrenListEnabled":"true"}],"child":[{"entityTypeId":3,"isChildrenListEnabled":"true"},{"entityTypeId":4}]}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.type.add

try
        {
        	const response = await $b24.callMethod(
        		'crm.type.add',
        		{
        			fields: {
        				title: "Смарт-процесс",
        				entityTypeId: 2024,
        				isAutomationEnabled: "Y",
        				isBeginCloseDatesEnabled: "Y",
        				isBizProcEnabled: "Y",
        				isCategoriesEnabled: "Y",
        				isClientEnabled: "Y",
        				isDocumentsEnabled: "Y",
        				isLinkWithProductsEnabled: "Y",
        				isMycompanyEnabled: "Y",
        				isObserversEnabled: "Y",
        				isRecyclebinEnabled: "Y",
        				isSetOpenPermissions: "Y",
        				isSourceEnabled: "Y",
        				isStagesEnabled: "Y",
        				isUseInUserfieldEnabled: "Y",
        				linkedUserFields: {
        					"CALENDAR_EVENT|UF_CRM_CAL_EVENT": "true",
        					"TASKS_TASK|UF_CRM_TASK": "true",
        				},
        				relations: {
        					parent: [
        						{
        							entityTypeId: 1,
        							isChildrenListEnabled: "true",
        						},
        						{
        							entityTypeId: 2,
        							isChildrenListEnabled: "true",
        						},
        						{
        							entityTypeId: 31,
        							isChildrenListEnabled: "true",
        							
        						},
        					],
        					child: [
        						{
        							entityTypeId: 3,
        							isChildrenListEnabled: "true",
        						},
        						{
        							entityTypeId: 4,
        						},
        					],
        				},
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.type.add',
                    [
                        'fields' => [
                            'title'                     => "Смарт-процесс",
                            'entityTypeId'              => 2024,
                            'isAutomationEnabled'       => "Y",
                            'isBeginCloseDatesEnabled'  => "Y",
                            'isBizProcEnabled'          => "Y",
                            'isCategoriesEnabled'       => "Y",
                            'isClientEnabled'           => "Y",
                            'isDocumentsEnabled'        => "Y",
                            'isLinkWithProductsEnabled' => "Y",
                            'isMycompanyEnabled'        => "Y",
                            'isObserversEnabled'        => "Y",
                            'isRecyclebinEnabled'       => "Y",
                            'isSetOpenPermissions'      => "Y",
                            'isSourceEnabled'           => "Y",
                            'isStagesEnabled'           => "Y",
                            'isUseInUserfieldEnabled'   => "Y",
                            'linkedUserFields'          => [
                                "CALENDAR_EVENT|UF_CRM_CAL_EVENT" => "true",
                                "TASKS_TASK|UF_CRM_TASK"          => "true",
                            ],
                            'relations'                 => [
                                'parent' => [
                                    [
                                        'entityTypeId'           => 1,
                                        'isChildrenListEnabled'  => "true",
                                    ],
                                    [
                                        'entityTypeId'           => 2,
                                        'isChildrenListEnabled'  => "true",
                                    ],
                                    [
                                        'entityTypeId'           => 31,
                                        'isChildrenListEnabled'  => "true",
                                    ],
                                ],
                                'child'  => [
                                    [
                                        'entityTypeId'           => 3,
                                        'isChildrenListEnabled'  => "true",
                                    ],
                                    [
                                        'entityTypeId'           => 4,
                                    ],
                                ],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding CRM type: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.type.add',
            {
                fields: {
                    title: "Смарт-процесс",
                    entityTypeId: 2024,
                    isAutomationEnabled: "Y",
                    isBeginCloseDatesEnabled: "Y",
                    isBizProcEnabled: "Y",
                    isCategoriesEnabled: "Y",
                    isClientEnabled: "Y",
                    isDocumentsEnabled: "Y",
                    isLinkWithProductsEnabled: "Y",
                    isMycompanyEnabled: "Y",
                    isObserversEnabled: "Y",
                    isRecyclebinEnabled: "Y",
                    isSetOpenPermissions: "Y",
                    isSourceEnabled: "Y",
                    isStagesEnabled: "Y",
                    isUseInUserfieldEnabled: "Y",
                    linkedUserFields: {
                        "CALENDAR_EVENT|UF_CRM_CAL_EVENT": "true",
                        "TASKS_TASK|UF_CRM_TASK": "true",
                    },
                    relations: {
                        parent: [
                            {
                                entityTypeId: 1,
                                isChildrenListEnabled: "true",
                            },
                            {
                                entityTypeId: 2,
                                isChildrenListEnabled: "true",
                            },
                            {
                                entityTypeId: 31,
                                isChildrenListEnabled: "true",
                                
                            },
                        ],
                        child: [
                            {
                                entityTypeId: 3,
                                isChildrenListEnabled: "true",
                            },
                            {
                                entityTypeId: 4,
                            },
                        ],
                    },
                },
            },
            (result) => {
                if (result.error())
                {
                    console.error(result.error());
        
                    return;
                }
        
                console.info(result.data());
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.type.add',
            [
                'fields' => [
                    'title' => "Смарт-процесс",
                    'entityTypeId' => 2024,
                    'isAutomationEnabled' => "Y",
                    'isBeginCloseDatesEnabled' => "Y",
                    'isBizProcEnabled' => "Y",
                    'isCategoriesEnabled' => "Y",
                    'isClientEnabled' => "Y",
                    'isDocumentsEnabled' => "Y",
                    'isLinkWithProductsEnabled' => "Y",
                    'isMycompanyEnabled' => "Y",
                    'isObserversEnabled' => "Y",
                    'isRecyclebinEnabled' => "Y",
                    'isSetOpenPermissions' => "Y",
                    'isSourceEnabled' => "Y",
                    'isStagesEnabled' => "Y",
                    'isUseInUserfieldEnabled' => "Y",
                    'linkedUserFields' => [
                        "CALENDAR_EVENT|UF_CRM_CAL_EVENT" => "true",
                        "TASKS_TASK|UF_CRM_TASK" => "true",
                    ],
                    'relations' => [
                        'parent' => [
                            [
                                'entityTypeId' => 1,
                                'isChildrenListEnabled' => "true",
                            ],
                            [
                                'entityTypeId' => 2,
                                'isChildrenListEnabled' => "true",
                            ],
                            [
                                'entityTypeId' => 31,
                                'isChildrenListEnabled' => "true",
                            ],
                        ],
                        'child' => [
                            [
                                'entityTypeId' => 3,
                                'isChildrenListEnabled' => "true",
                            ],
                            [
                                'entityTypeId' => 4,
                            ],
                        ],
                    ],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "type": {
                    "id": 16,
                    "createdBy": 1,
                    "entityTypeId": 2024,
                    "isCategoriesEnabled": "Y",
                    "isStagesEnabled": "Y",
                    "isBeginCloseDatesEnabled": "Y",
                    "isClientEnabled": "Y",
                    "isUseInUserfieldEnabled": "Y",
                    "isLinkWithProductsEnabled": "Y",
                    "isMycompanyEnabled": "Y",
                    "isDocumentsEnabled": "Y",
                    "isSourceEnabled": "Y",
                    "isObserversEnabled": "Y",
                    "isRecyclebinEnabled": "Y",
                    "isAutomationEnabled": "Y",
                    "isBizProcEnabled": "Y",
                    "isSetOpenPermissions": "Y",
                    "isPaymentsEnabled": "N",
                    "isCountersEnabled": "N",
                    "createdTime": "2024-07-05T19:47:33+02:00",
                    "updatedTime": "2024-07-05T19:47:33+02:00",
                    "updatedBy": 1,
                    "title": "Смарт-процесс",
                    "relations": {
                        "parent": [
                            {
                                "entityTypeId": 3,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "Y"
                            },
                            {
                                "entityTypeId": 4,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "Y"
                            },
                            {
                                "entityTypeId": 1,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "N"
                            },
                            {
                                "entityTypeId": 2,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "N"
                            },
                            {
                                "entityTypeId": 31,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "N"
                            }
                        ],
                        "child": [
                            {
                                "entityTypeId": 3,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "N"
                            },
                            {
                                "entityTypeId": 4,
                                "isChildrenListEnabled": "N",
                                "isPredefined": "N"
                            }
                        ]
                    },
                    "linkedUserFields": {
                        "CALENDAR_EVENT|UF_CRM_CAL_EVENT": "Y",
                        "TASKS_TASK|UF_CRM_TASK": "Y",
                        "TASKS_TASK_TEMPLATE|UF_CRM_TASK": "N"
                    },
                    "customSections": [],
                    "customSectionId": null
                }
            },
            "time": {
                "start": 1720201651.707909,
                "finish": 1720201654.748627,
                "duration": 3.040717840194702,
                "processing": 2.71589994430542,
                "date_start": "2024-07-05T19:47:31+02:00",
                "date_finish": "2024-07-05T19:47:34+02:00",
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `object`	Корневой элемент ответа. Содержит единственный ключ `type`
type `type`	Информация о созданном смарт-процессе
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400, 403

{
            "error": "INVALID_ARG_VALUE", 
            "error_description": "entityTypeId is out of allowed range"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Статус	Код	Описание	Значение
`400`	`INVALID_ARG_VALUE`	entityTypeId is out of allowed range	Возникает, при передаче невалидного `entityTypeId`
`400`	`ACCESS_DENIED`	Доступ запрещен	Возникает, если у пользователя нет административных прав CRM
`403`	`allowed_only_intranet_user`	Действие разрешено только интранет-пользователям	Возникает, если пользователь не является интранет-пользователем
`400`	`100`	Could not find value for parameter	Возникает, если не передан обязательный параметр `fields`
`400`	`0`	Выберите рабочее место, в котором будет находиться смарт-процесс	При передаче `isExternal = 'true'`, но пустом `customSectionId`
`400`	`CREATE_DYNAMIC_TYPE_RESTRICTED`	Превышено максимальное количество смарт-процессов	Создание смарт-процесса ограничено из-за тарифа

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

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

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

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Обзор методов

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

Создать новый пользовательский тип crm.type.add

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

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

Связи relationsСвязи relations

Одна связь relationОдна связь relation

Привязка к пользовательским полямПривязка к пользовательским полям

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

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

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

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

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

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

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

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

Параметр fields

Связи relations

Одна связь relation

Привязка к пользовательским полям

Примеры кода

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

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

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

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

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

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