Добавить новую воронку crm.category.add

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

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

Scope: crm

Кто может выполнять метод: любой пользователь с административным доступом к разделу 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 все равно возможна

Примеры кода

Создать новую воронку по умолчанию в смарт-процессе с entityTypeId = 1152.

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

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
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId": 1152, "fields": {"name": "Новая воронка по умолчанию", "sort": 50, "isDefault": "Y"}, "auth": "**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.category.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type CategoryAddResult = {
  category: {
    id: number
    name: string
    sort: number
    entityTypeId: number
    isDefault: string
  }
}

try {
  const response = await $b24.actions.v2.call.make<CategoryAddResult>({
    method: 'crm.category.add',
    params: {
      entityTypeId: 1152,
      fields: {
        name: 'New default pipeline',
        sort: 50,
        isDefault: 'Y',
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.category.id, result.category.name)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function addCategory() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.category.add',
        params: {
          entityTypeId: 1152,
          fields: {
            name: 'New default pipeline',
            sort: 50,
            isDefault: 'Y',
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.category.id, result.category.name)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addCategory)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.category.add(
        fields={
            "name": "Новая воронка по умолчанию",
            "sort": 50,
            "isDefault": "Y",
        },
        entity_type_id=1152,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service
        ->core
        ->call(
            'crm.category.add',
            [
                'entityTypeId' => 1152,
                'fields' => [
                    'name'     => 'Новая воронка по умолчанию',
                    'sort'     => 50,
                    'isDefault' => 'Y',
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    // Нужная вам логика обработки данных
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding category: ' . $e->getMessage();
}
BX24.callMethod(
    "crm.category.add",
    {
        entityTypeId: 1152,
        fields: {
            name: "Новая воронка по умолчанию",
            sort: 50,
            isDefault: 'Y',
        },
    },
    (result) => 
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.info(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'crm.category.add',
    [
        'entityTypeId' => 1152,
        'fields' => [
            'name' => "Новая воронка по умолчанию",
            'sort' => 50,
            'isDefault' => 'Y',
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.category.add", b24.Params{
	"entityTypeId": 1152,
	"fields": b24.Params{
		"name":      "Новая воронка по умолчанию",
		"sort":      50,
		"isDefault": "Y",
	},
})
if err != nil {
	return fmt.Errorf("crm.category.add: %w", err)
}

// Метод заворачивает ответ в объект с ключом "category".
raw, ok := b24.Unwrap(res.Result, "category")
if !ok {
	return fmt.Errorf("в ответе нет ключа category")
}

var item struct {
	ID           b24.ID `json:"id"`
	Name         string `json:"name"`
	Sort         int    `json:"sort"`
	EntityTypeID b24.ID `json:"entityTypeId"`
	IsDefault    string `json:"isDefault"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Name)

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

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

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

Объект category

Название
тип

Описание

id
integer

Идентификатор воронки (направления)

name
string

Название воронки

sort
integer

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

entityTypeId
integer

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

isDefault
boolean

Является ли воронка, воронкой по умолчанию

originId
string

Идентификатор источника данных.

Существует только в cделках

originatorId
string

Идентификатор элемента в источнике данных.

Существует только в cделках

isSystem
boolean

Является ли воронка системной.

Существует только в смарт-процессах

code
string

Псевдоним для системных воронок.

Существует только в смарт-процессах

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

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

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

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
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

Возникает при попытке создать воронку по умолчанию для контактов или компаний

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

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

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая