# crm.category.add

URL: https://chugunov.pro/api-bitrix24/crm/universal/category/crm-category-add/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

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

## Описание

Метод создает у типа объекта CRM с идентификатором `entityTypeId` новую воронку (направление).

## Параметры

- `entityTypeId` `integer` — обязательный. Идентификатор [системного](https://chugunov.pro/api-bitrix24/crm/) или [пользовательского типа](https://chugunov.pro/api-bitrix24/crm/universal/user-defined-object-types/) сущности CRM для которой будет создана новая воронка
- `fields` `object` — обязательный. Значения полей (подробное описание приведено [ниже](#parametr-fields)) для добавления новой воронки в виде структуры:
  ```js
  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 все равно возможна

## Ответ

HTTP-статус: 200

```json
{
    "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`](#category) с информацией о воронке
- `time` `object`. Объект, содержащий в себе информацию о времени выполнения запроса

## Ошибки

HTTP-статус: 160

```json
{
    "error": "NOT_FOUND", 
    "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. Возникает при попытке создать воронку по умолчанию для `контактов` или `компаний`

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

### cURL (Webhook)

```bash
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 (OAuth)

```bash
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
```

### JS (TS)

```ts
// 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)
}
```

### JS (UMD)

```html
<!-- 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>
```

### Python

```python
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}")
```

### PHP

```php
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.js

```js
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());
        }
    }
);
```

### PHP CRest

```php
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>';
```

### Go

```go
// 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)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/crm/universal/category/crm-category-add.html