Create CRM Status Element crm.status.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: user with CRM administrator rights

The method crm.status.add creates a new element in the specified CRM directory: deal stage, source, company type, and others.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

Object with fields of the new directory element. The list of available fields is described below

Parameter fields

Name
type

Description

ENTITY_ID*
string

Type of directory, for example DEAL_STAGE, SOURCE. You can get the list of types using the method crm.status.entity.types

STATUS_ID*
string

Status value code. The code must be unique within the directory. Length and character restrictions depend on the type of directory

NAME*
string

Name

SORT
integer

Sorting. Default is 10

COLOR
string

Hex color code, for example #39A8EF. Use for status stages

SEMANTICS
string

Group of stages:

  • "S" — "Success",
  • "F" — "Failure",
  • "" — "In Progress".

Use for status stages. Default is "In Progress" group

Field Features

Restrictions for STATUS_ID

Follow the length and character restrictions for different types of directories:

  • STATUS lead stages. Max length: 21, can contain only Latin letters, numbers, hyphens, and underscores.
  • QUOTE_STATUS estimate stages. Max length: 22, can contain only Latin letters, numbers, hyphens, and underscores.
  • DEAL_STAGE deal stages. Max length: 22, can contain only Latin letters, numbers, hyphens, and underscores.
  • DEAL_STAGE_xx deal stages in non-default pipelines. xx — pipeline identifier. Max length depends on the pipeline identifier. Can contain only Latin letters, numbers, hyphens, and underscores.
  • For other ENTITY_ID, the maximum length of STATUS_ID is 50 characters and can contain any characters.

If a stage is added for a custom deal pipeline, the status identifier will automatically have the pipeline prefix added. This is necessary to identify the pipeline by the stage identifier.

For example, the value DECISION for a deal pipeline with identifier 1 will be saved as C1:DECISION. The system will automatically add the prefix C1: corresponding to the deal pipeline identifier.
If a value is passed to the field with the prefix C1:DECISION, it will be saved as C1:DECISION, and no additional prefix will be added.

For SPAs with pipelines, a similar logic for forming STATUS_ID from the value and prefix applies. The pipeline prefix can be obtained using the method crm.status.entity.types.

Restrictions for SORT

For the correct operation of status stages, the sorting must follow this order:

  1. Stages of the "In Progress" group
  2. Stage of the "Success" group
  3. Stages of the "Failure" group

Code Examples

How to Use Examples in Documentation

curl -X POST \
             -H "Content-Type: application/json" \
             -H "Accept: application/json" \
             -d '{"fields":{"ENTITY_ID":"DEAL_STAGE_1","STATUS_ID":"DECISION","NAME":"Decision making","SORT":70,"COLOR":"#FFA900"}}' \
             https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.status.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"ENTITY_ID":"DEAL_STAGE_1","STATUS_ID":"DECISION","NAME":"Decision making","SORT":70,"COLOR":"#FFA900"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.status.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
        
        try {
          const response = await $b24.actions.v2.call.make<number>({
            method: 'crm.status.add',
            params: {
              fields: {
                ENTITY_ID: 'DEAL_STAGE_1',
                STATUS_ID: 'DECISION',
                NAME: 'Decision',
                SORT: 70,
                COLOR: '#FFA900',
              },
            },
            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('Created status id:', result)
          }
        } 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 addStatus() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.status.add',
                params: {
                  fields: {
                    ENTITY_ID: 'DEAL_STAGE_1',
                    STATUS_ID: 'DECISION',
                    NAME: 'Decision',
                    SORT: 70,
                    COLOR: '#FFA900',
                  },
                },
                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('Created status id:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addStatus)
        </script>
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.status.add(
                fields={
                    "ENTITY_ID": "DEAL_STAGE_1",
                    "STATUS_ID": "DECISION",
                    "NAME": "Decision making",
                    "SORT": 70,
                    "COLOR": "#FFA900",
                },
            ).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.status.add',
                    [
                        'fields' => [
                            'ENTITY_ID' => 'DEAL_STAGE_1',
                            'STATUS_ID' => 'DECISION',
                            'NAME'     => 'Decision making',
                            'SORT'     => 70,
                            'COLOR'    => '#FFA900',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding status: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.status.add",
            {
                fields: {
                    ENTITY_ID: "DEAL_STAGE_1",
                    STATUS_ID: "DECISION",
                    NAME: "Decision making",
                    SORT: 70,
                    COLOR: "#FFA900"
                }
            },
            function(result) {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.status.add',
            [
                'fields' => [
                    'ENTITY_ID' => 'DEAL_STAGE_1',
                    'STATUS_ID' => 'DECISION',
                    'NAME' => 'Decision making',
                    'SORT' => 70,
                    'COLOR' => '#FFA900'
                ]
            ]
        );
        
        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.status.add", b24.Params{
        	"fields": b24.Params{
        		"ENTITY_ID": "DEAL_STAGE_1",
        		"STATUS_ID": "DECISION",
        		"NAME":      "Decision making",
        		"SORT":      70,
        		"COLOR":     "#FFA900",
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.status.add: %w", err)
        }
        
        var newID b24.ID
        if err := json.Unmarshal(res.Result, &newID); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("id:", newID)
        

Response Handling

HTTP status: 200

{
            "result": 773,
            "time": {
                "start": 1752215174.862923,
                "finish": 1752215174.916697,
                "duration": 0.053774118423461914,
                "processing": 0.014070987701416016,
                "date_start": "2025-07-11T09:26:14+03:00",
                "date_finish": "2025-07-11T09:26:14+03:00",
                "operating_reset_at": 1752215774,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
integer

Identifier of the created directory element

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "The field STATUS_ID is required."
        }
        

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

Status

Code

Description

Value

400

Empty value

The field ENTITY_ID is required., The field STATUS_ID is required.

The required field ENTITY_ID or STATUS_ID was not passed. If both are missing, both messages arrive in the same response

400

Empty value

Parameter 'fields' must be array.

The fields parameter received a value that is not an object

400

Empty value

Specified entity type is not supported.

The ENTITY_ID field received a directory that does not exist in CRM

400

Empty value

The field Title is required.

The element name NAME was not passed

400

Empty value

Cannot create more stages after the final stage because the final successful stage already exists. Try using sort order values less than that of the final stage.

For the DEAL_STAGE directory, the SORT field received a value greater than that of the WON stage

400

Empty value

Access denied.

The user does not have the permission to modify CRM settings

400

Empty value

Error on creating status.

The directory element was not created, and the system did not return the reason

400

ERROR_CORE

The specified status ID already exists.

The ENTITY_ID directory already contains an element with this STATUS_ID

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