Создать элемент справочника crm.status.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правами администратора CRM
Метод crm.status.add создает новый элемент в указанном справочнике CRM: стадия сделки, источник, тип компании и другие.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Объект с полями нового элемента справочника. Список доступных полей описан ниже |
Параметр fields
|
Название |
Описание |
|
ENTITY_ID* |
Тип справочника, например |
|
STATUS_ID* |
Код значения статуса. Код должен быть уникальным в рамках справочника. Ограничения по длине и символам зависят от типа справочника |
|
NAME* |
Название |
|
SORT |
Сортировка. По умолчанию 10 |
|
COLOR |
Цвет hex-код, например |
|
SEMANTICS |
Группа стадий:
Используйте для статусов-стадий. По умолчанию передается группа «В работе» |
Особенности полей
Ограничения для STATUS_ID
Соблюдайте ограничения по длине и используемым символам для разных типов справочников:
- STATUS стадии лида. Макс. длина: 21, может содержать только латинские буквы, цифры, знаки тире и подчеркивания.
- QUOTE_STATUS стадии предложения. Макс. длина: 22, может содержать только латинские буквы, цифры, знаки тире и подчеркивания.
- DEAL_STAGE стадии сделки. Макс. длина: 22, может содержать только латинские буквы, цифры, знаки тире и подчеркивания.
- DEAL_STAGE_xx стадии сделки в воронках не по умолчанию. xx — идентификатор воронки. Макс. длина зависит от идентификатора воронки. Может содержать только латинские буквы, цифры, знаки тире и подчеркивания.
- Для остальных
ENTITY_ID, максимальная длинаSTATUS_ID- 50 символов, содержать может любые символы.
Если добавляется стадия для пользовательской воронки сделок, то к идентификатору статуса будет автоматически добавлен префикс воронки. Это нужно, чтобы определить воронку по идентификатору стадии.
Например, значение DECISION для воронки сделок с идентификатором 1 будет сохранено как С1:DECISION. Система автоматически добавит префикс C1:, соответствующий идентификатору воронки сделок.
При передаче в поле значения сразу с префиксом С1:DECISION оно будет сохранено как С1:DECISION, дополнительный префикс не добавится.
Для смарт-процессов с воронками действует аналогичная логика формирования STATUS_ID из значения и префикса. Префикс воронки можно узнать методом crm.status.entity.types.
Ограничения для SORT
Для корректной работы статусов-стадий сортировка должна соблюдать порядок:
- Стадии группы «В работе»
- Стадия группы «Успех»
- Стадии группы «Провал»
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"ENTITY_ID":"DEAL_STAGE_1","STATUS_ID":"DECISION","NAME":"Принятие решения","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":"Принятие решения","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>
try {
$response = $b24Service
->core
->call(
'crm.status.add',
[
'fields' => [
'ENTITY_ID' => 'DEAL_STAGE_1',
'STATUS_ID' => 'DECISION',
'NAME' => 'Принятие решения',
'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();
}
Пример
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.status.add(
fields={
"ENTITY_ID": "DEAL_STAGE_1",
"STATUS_ID": "DECISION",
"NAME": "Принятие решения",
"SORT": 70,
"COLOR": "#FFA900",
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
BX24.callMethod(
"crm.status.add",
{
fields: {
ENTITY_ID: "DEAL_STAGE_1",
STATUS_ID: "DECISION",
NAME: "Принятие решения",
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' => 'Принятие решения',
'SORT' => 70,
'COLOR' => '#FFA900'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 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
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Идентификатор созданного элемента справочника |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "Invalid parameters.",
"error_description": "Переданы некорректные параметры."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
|
Нет прав на выполнение операции |
|
|
|
Переданы некорректные параметры |
|
|
|
Указан неподдерживаемый тип справочника |
|
|
|
Не указан |
|
|
|
Не указан |
|
|
|
Такой |
|
|
|
Ошибка при создании элемента |
|
|
|
Нельзя создать промежуточную стадию после успешной |
|
|
|
Не заполнено обязательное поле "Заголовок" |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Получить список элементов справочника по фильтру crm.status.list
- Получить элемент справочника по идентификатору crm.status.get
- Обновить элемент справочника crm.status.update
- Удалить элемент справочника crm.status.delete
- Получить описание полей справочника crm.status.fields
- Получить типы справочников crm.status.entity.types
- Как создать новую воронку со стадиями в смарт-процессе