Create a CRM Pipeline v 3.0 crm.[type].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: a CRM administrator or a user with the "Manage pipelines" permission in a CRM access role. For an SPA of a digital workplace — an administrator of this digital workplace or a user with the "Manage pipelines" permission in a digital workplace access role

This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.

The crm.<type>.category.add method creates a pipeline for a CRM object type and returns its ID. The object type is set by the <type> segment of the method name.

Method Name for the Object Type

Object type	Method
Deal	`crm.deal.category.add`
Contact	`crm.contact.category.add`
Company	`crm.company.category.add`
SPA	`crm.smartprocess<entityTypeId>.category.add`, for example, `crm.smartprocess1038.category.add`

For an SPA, the method name includes its type ID entityTypeId. SPA type IDs are returned by the crm.type.list method in the entityTypeId field.

Deals, contacts, and companies have pipelines, and so does an SPA if pipelines are enabled in its type settings. Leads, estimates, invoices, and my company have none.

The method name is written in lowercase: crm.smartprocess1038.category.add, not crm.smartProcess1038.category.add. If the name is written in a different case, the method returns the "Method Not Found" error.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Object with the fields of the new pipeline in the format `{"field": "value"}`. The required field is `name`. Parameter description

The fields Parameter

Required parameters are marked with *

Field names are written in camelCase: name, sort, isDefault.

Name `type`	Description
name* `string`	Pipeline name, up to 100 characters. The method does not accept an empty string or a string of spaces only
sort `integer`	Pipeline order: the crm.<type>.category.list method returns pipelines in ascending `sort` order. The default value depends on the object type — object type differences
isDefault `boolean`	Default pipeline flag. The method accepts the field for a contact, a company, and an SPA — object type differences. Possible values: `true` — the new pipeline becomes the default pipeline instead of the previous one `false` — the new pipeline is a regular one Default: `false`

The id field is read-only, and the method does not accept it. The list of pipeline fields with a flag showing whether a field can be changed is returned by the crm.<type>.category.field.list method.

Object Type Differences

What differs	Deal	Contact, company	SPA
Stages of a new pipeline	Default stages are created	No stages	Default stages are created if stages are enabled in the type settings
`isDefault` on creation	Read-only: the method returns an error	Can be passed	Can be passed
Default `sort`	`0`	`500`	`500`
Negative `sort`	The method stores `0`	The method stores the value as is	The method stores the value as is
Leading and trailing spaces in `name`	The method trims them	The method retains them	The method retains them
`isSystem` and `code` pipeline fields	None: the method returns an unknown field error	Present, read-only	Present, read-only

The stages that Bitrix24 created in the new pipeline are returned by the crm.<type>.category.stage.list method.

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ segment to the request URL:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/crm.smartprocess1038.category.add

The examples create a pipeline in an SPA with the type ID 1038. For a different object type, replace the method name according to the table above.

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"name":"Equipment procurement","sort":600}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.category.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"name":"Equipment procurement","sort":600},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.category.add

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make: such a call returns the SDK error JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(ApiVersion.v3).call.

import { ApiVersion, Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type CategoryAddResult = {
          id: number
        }
        
        try {
          const response = await $b24.getHttpClient(ApiVersion.v3).call<CategoryAddResult>(
            'crm.smartprocess1038.category.add',
            {
              fields: {
                name: 'Equipment procurement',
                sort: 600,
              },
            },
            Text.getUuidRfc4122()
          )
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Category created:', result.id)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(B24Js.ApiVersion.v3).call.

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function addCategory() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
                'crm.smartprocess1038.category.add',
                {
                  fields: {
                    name: 'Equipment procurement',
                    sort: 600,
                  },
                },
                B24Js.Text.getUuidRfc4122()
              )
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Category created:', result.id)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addCategory)
        </script>

b24pysdk has no ready-made wrappers for CRM methods, and the SDK sends to REST 3.0 only the methods from the Config().api_v3_methods list. Add the method to this list and call it via bitrix_token.call_method with prefer_version=3.

from b24pysdk import Config
        from b24pysdk.errors import BitrixSDKException
        from b24pysdk.errors.v3 import BitrixAPIError
        
        method = "crm.smartprocess1038.category.add"
        Config().configure(api_v3_methods=Config().api_v3_methods | {method})
        
        try:
            response = bitrix_token.call_method(
                api_method=method,
                params={
                    "fields": {
                        "name": "Equipment procurement",
                        "sort": 600,
                    },
                },
                prefer_version=3,
            )
            result = response["result"]
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"code: {error.code}",
                f"message: {error.error.message}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.smartprocess1038.category.add',
                    [
                        'fields' => [
                            'name' => 'Equipment procurement',
                            'sort' => 600,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

BX24.callMethod(
            'crm.smartprocess1038.category.add',
            {
                fields: {
                    name: 'Equipment procurement',
                    sort: 600,
                },
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'crm.smartprocess1038.category.add',
            [
                'fields' => [
                    'name' => 'Equipment procurement',
                    'sort' => 600,
                ],
            ]
        );
        
        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.smartprocess1038.category.add", b24.Params{
        	"fields": b24.Params{
        		"name": "Equipment procurement",
        		"sort": 600,
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.smartprocess1038.category.add: %w", err)
        }
        
        var created struct {
        	ID int `json:"id"`
        }
        if err := json.Unmarshal(res.Result, &created); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(created.ID)

Response Handling

HTTP status: 200

{
            "result": {
                "id": 113
            },
            "time": {
                "start": 1793711086,
                "finish": 1793711086.787867,
                "duration": 0.7878670692443848,
                "processing": 0,
                "date_start": "2026-11-03T16:04:46+03:00",
                "date_finish": "2026-11-03T16:04:46+03:00",
                "operating_reset_at": 1793711520,
                "operating": 0.1263599395751953
            }
        }

Returned Data

Name `type`	Description
result `object`	Object with response data
result.id `integer`	ID of the created pipeline. Pass it in `categoryId` when you create items and stages in this pipeline for a deal or an SPA. The pipeline fields can be retrieved with the crm.<type>.category.get method
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
                "message": "Error validating object.",
                "validation": [
                    {
                        "message": "Required field \"name\" is empty.",
                        "field": "name"
                    }
                ]
            }
        }

Name `type`	Description
error.code `string`	String error code. Use it to identify the type of exception
error.message `string`	Text description of the error
error.validation `array`	Array with error details. Present only in data validation errors `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Name of the field where the validation error occurred
error.validation[].message `string`	Description of the error related to the specified field

Possible Error Codes

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field	Error description	How to Fix
`fields`	Required field `fields` is missing	Pass the `fields` object
`sort`	This request requires data type `int` in field `sort`	Pass a value of the type specified in the field description
`FIELD_VALUE_NOT_ALLOWED`	Invalid field value	The name consists of spaces only. Pass a name in `name` that contains more than spaces. The `field` contains the error code, not a field name

Object Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Field	Error description	How to Fix
`name`	Required field "name" is empty	Pass `name` in `fields`
`name`	Field value must not be empty	An empty string. Pass a non-empty string in `name`
`name`	String must not be longer than 100 characters	Shorten the name to 100 characters
`id`, `isSystem`, `code`	Field "#FIELD#" is read-only	Remove the field from `fields`: it is read-only. For `isSystem` and `code`, this error is returned for a contact, a company, and an SPA
`isDefault`	Field "isDefault" is read-only	Remove `isDefault` from `fields`. For a deal, the method returns this error because the field is read-only

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field	Error description	How to Fix
`-`	Unknown field `#FIELD#` found in entity `#DTO#`	Check the parameter name against the fields parameter table. Names are written in camelCase: `name`, not `NAME`. If the error names the field `0`, `fields` was passed as a string or a non-empty array. Pass `fields` as an object
`-`	Unknown field `isSystem` found in entity `CategoryDealDto`	A deal pipeline has no `isSystem` or `code` fields. Remove them from `fields`

Access Denied

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION, HTTP status: 403

Field	Error description	How to Fix
`-`	Access denied	Call the method on behalf of a CRM administrator or a user with the "Manage pipelines" permission in an access role

Method Not Found

Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP status: 404

Field	Error description	How to Fix
`-`	Method `#METHOD#` was not found	Check the method name: it is written in lowercase, for example, `crm.smartprocess1038.category.add`. For an SPA, check `entityTypeId` with the crm.type.list method and whether pipelines are enabled in the type

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

Was the article helpful?

Overview of Methods

Update a Pipeline

Create a CRM Pipeline v 3.0 crm.[type].category.add

Method Name for the Object TypeMethod Name for the Object Type

Method ParametersMethod Parameters

The fields ParameterThe fields Parameter

Object Type DifferencesObject Type Differences

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Request Validation ErrorsRequest Validation Errors

Object Validation ErrorsObject Validation Errors

Unknown Field ErrorUnknown Field Error

Access DeniedAccess Denied

Method Not FoundMethod Not Found

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Name for the Object Type

Method Parameters

The fields Parameter

Object Type Differences

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Request Validation Errors

Object Validation Errors

Unknown Field Error

Access Denied

Method Not Found

Statuses and System Error Codes

Continue Learning