Update Sales Funnel crm.category.update

Scope: crm

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

This method updates the funnel (direction) with the identifier id, setting new values for the fields from fields. If any field is missing in fields, its value will remain unchanged.

Method Parameters

Required parameters are marked with *

Name `type`	Description
entityTypeId* `integer`	Identifier of the system or user-defined type of CRM entities for which the funnel will be updated
id* `integer`	Identifier of the funnel. It can be obtained using the `crm.category.list` method or when creating a funnel with the `crm.category.add` method
fields* `object`	Field values (detailed description provided below) for updating the funnel fields in the form of a structure: `fields: { name: "value", sort: "value", isDefault: "value", },`

Parameter fields

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 `sort = 0` will be set. 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. You can find out if the field is immutable using the `crm.category.fields` method. Immutable fields have the property `isReadonly = true`

Code Examples

How to update a funnel with id = 4 in an SPA with entityTypeId = 1152

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":1152,"id":4,"fields":{"name":"New Funnel Name","sort":1000,"isDefault":"Y"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.category.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":1152,"id":4,"fields":{"name":"New Funnel Name","sort":1000,"isDefault":"Y"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.category.update

try
        {
        	const response = await $b24.callMethod(
        		"crm.category.update",
        		{
        			entityTypeId: 1152,
        			id: 4,
        			fields: {
        				name: "New Funnel Name",
        				sort: 1000,
        				isDefault: "Y",
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.category.update',
                    [
                        'entityTypeId' => 1152,
                        'id'          => 4,
                        'fields'      => [
                            'name'     => 'New Funnel Name',
                            'sort'     => 1000,
                            'isDefault' => 'Y',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your data processing logic
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating category: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.category.update",
            {
                entityTypeId: 1152,
                id: 4,
                fields: {
                    name: "New Funnel Name",
                    sort: 1000,
                    isDefault: "Y",
                },
            },
            (result) => 
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.category.update',
            [
                'entityTypeId' => 1152,
                'id' => 4,
                'fields' => [
                    'name' => "New Funnel Name",
                    'sort' => 1000,
                    'isDefault' => "Y"
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "category": {
                    "id": 4,
                    "name": "New Funnel Name",
                    "sort": 1000,
                    "entityTypeId": 1152,
                    "isDefault": "Y"
                }
            },
            "time": {
                "start": 1718359296.368324,
                "finish": 1718359296.65352,
                "duration": 0.28519606590270996,
                "processing": 0.03645014762878418,
                "date_start": "2024-06-14T12:01:36+02:00",
                "date_finish": "2024-06-14T12:01:36+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response. Contains the `category` object
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "NOT_FOUND",
            "error_description": "Smart process 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`	Smart process 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
`NOT_FOUND`	Element not found	Occurs if the funnel being updated does not exist
`ACCESS_DENIED`	Access denied	Occurs if the user updating the funnel does not have sufficient rights

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

Add a New Funnel

Get Funnel by Id

Update Sales Funnel crm.category.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning