Add a New Sales Funnel crm.category.add

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 entity 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
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.category.add',
        		{
        			entityTypeId: 1152,
        			fields: {
        				name: 'New Default Funnel',
        				sort: 50,
        				isDefault: 'Y',
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.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>';

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 may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

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: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not allowed to be called using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

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

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

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users

500

PORTAL_DELETED
Portal was deleted

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

Continue Learning

Previous
Overview of Methods
Next
Update Funnel