Add a New Sales Funnel crm.category.add

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: crm

Who can execute the method: any user with administrative access to the CRM section

This method creates a new sales funnel (direction) for the CRM object type with the identifier entityTypeId.

Method Parameters

Required parameters are marked with *

Name
type

Description

entityTypeId*
integer

Identifier of the system or user-defined type of the CRM object for which the new funnel will be created

fields*
object

Field values (detailed description provided below) for adding a new funnel in the form of a structure:

fields: {
            name: "value",
            sort: "value",
            isDefault: "value",
        },
        

Parameter fields

Required parameters are marked with *

Name
type

Description

name*
string

Name of the funnel. The name can be:

  • length cannot exceed 255 characters
  • cannot be empty
  • cannot consist solely of spaces, tabs, etc.

Defaults to -

sort
integer

Sort index.

Cannot be negative. If a value less than zero is passed to sort, it will be ignored and set to sort = 0

Defaults to 500

isDefault
boolean

Indicates whether the funnel is the default funnel. Can have values:

  • Y — yes, it is
  • N — no

Defaults to N.

In deals, the isDefault field is not available for modification.

Restrictions on changing the isDefault field in SPAs:

  • the default direction cannot be deleted,
  • when creating a new direction and passing it the flag isDefault: "Y", the old default direction will cease to be the default direction,
  • when changing the default direction, it cannot be made a non-default direction,
  • when changing a non-default direction and passing it the flag isDefault: "Y", the old default direction will cease to be the default direction.

If the display of directions in the interface is disabled for an existing SPA, working with directions via REST is still possible.

Code Examples

Create a new default funnel in the SPA with entityTypeId = 1152.

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId": 1152, "fields": {"name": "New Default Funnel", "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": "New Default Funnel", "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": "New default pipeline",
                    "sort": 50,
                    "isDefault": "Y",
                },
                entity_type_id=1152,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.category.add',
                    [
                        'entityTypeId' => 1152,
                        'fields' => [
                            'name'     => 'New Default Funnel',
                            'sort'     => 50,
                            'isDefault' => 'Y',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your logic for processing data
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding category: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.category.add",
            {
                entityTypeId: 1152,
                fields: {
                    name: "New Default Funnel",
                    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' => "New Default Funnel",
                    'sort' => 50,
                    'isDefault' => 'Y',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.category.add", b24.Params{
        	"entityTypeId": 1152,
        	"fields": b24.Params{
        		"name":      "New Default Funnel",
        		"sort":      50,
        		"isDefault": "Y",
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.category.add: %w", err)
        }
        
        // The method wraps the response in an object with the "category" key.
        raw, ok := b24.Unwrap(res.Result, "category")
        if !ok {
        	return fmt.Errorf("no category key in the response")
        }
        
        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("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Name)
        

Response Handling

HTTP Status: 200

{
            "result": {
                "category": {
                    "id": 5,
                    "name": "New Default Funnel",
                    "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
            }
        }
        

Returned Values

Name
type

Description

result
object

Root element of the response. Contains the category object with information about the funnel

time
object

Object containing information about the execution time of the request

Object category

Name
type

Description

id
integer

Identifier of the funnel (direction)

name
string

Name of the funnel

sort
integer

Sort index

entityTypeId
integer

Identifier of the system or user-defined type to which the funnel belongs

isDefault
boolean

Indicates whether the funnel is the default funnel

originId
string

Identifier of the data source.

Exists only in deals

originatorId
string

Identifier of the element in the data source.

Exists only in deals

isSystem
boolean

Indicates whether the funnel is a system funnel.

Exists only in SPAs

code
string

Alias for system funnels.

Exists only in SPAs

Error Handling

HTTP Status: 160, 400

{
            "error": "NOT_FOUND", 
            "error_description": "SPA not found"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Value

NOT_FOUND

SPA not found

Occurs with incorrect values for entityTypeId

ENTITY_TYPE_NOT_SUPPORTED

Entity type {entityTypeName} is not supported

Occurs if the CRM object does not support funnels

ADDING_DISABLED

Adding a system category is prohibited

Occurs when attempting to create a system funnel in SPAs

ACCESS_DENIED

Access denied

Occurs if the user does not have sufficient rights to add a funnel

0

Field 'NAME' is required

Occurs if the required field name is not provided

0

Default client category does not support updating default state

Occurs when attempting to create a default funnel for contacts or companies

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning