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:
crmWho 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 |
Description |
|
fields* |
Object with fields of the new directory element. The list of available fields is described below |
Parameter fields
|
Name |
Description |
|
ENTITY_ID* |
Type of directory, for example |
|
STATUS_ID* |
Status value code. The code must be unique within the directory. Length and character restrictions depend on the type of directory |
|
NAME* |
Name |
|
SORT |
Sorting. Default is 10 |
|
COLOR |
Hex color code, for example |
|
SEMANTICS |
Group of stages:
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 ofSTATUS_IDis 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:
- Stages of the "In Progress" group
- Stage of the "Success" group
- 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 |
Description |
|
result |
Identifier of the created directory element |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "",
"error_description": "The field STATUS_ID is required."
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
Empty value |
|
The required field |
|
|
Empty value |
|
The |
|
|
Empty value |
|
The |
|
|
Empty value |
|
The element name |
|
|
Empty value |
|
For the |
|
|
Empty value |
|
The user does not have the permission to modify CRM settings |
|
|
Empty value |
|
The directory element was not created, and the system did not return the reason |
|
|
|
|
The |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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
- Get a List of Directory Items by Filter crm.status.list
- Get a Directory Item by ID crm.status.get
- Update CRM Status Element crm.status.update
- Delete CRM Status Element crm.status.delete
- Get Description of CRM Status Fields crm.status.fields
- Get CRM Status Entity Types crm.status.entity.types
- How to Create a New Sales Funnel with Stages in a Smart Process