Создать элемент справочника crm.status.add

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: пользователь с правами администратора CRM

Метод crm.status.add создает новый элемент в указанном справочнике CRM: стадия сделки, источник, тип компании и другие.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

fields*
object

Объект с полями нового элемента справочника. Список доступных полей описан ниже

Параметр fields

Название
тип

Описание

ENTITY_ID*
string

Тип справочника, например DEAL_STAGE, SOURCE. Получить список типов можно методом crm.status.entity.types

STATUS_ID*
string

Код значения статуса. Код должен быть уникальным в рамках справочника. Ограничения по длине и символам зависят от типа справочника

NAME*
string

Название

SORT
integer

Сортировка. По умолчанию 10

COLOR
string

Цвет hex-код, например #39A8EF. Используйте для статусов-стадий

SEMANTICS
string

Группа стадий:

  • "S" — «Успех»,
  • "F" — «Провал»,
  • "" — «В работе».

Используйте для статусов-стадий. По умолчанию передается группа «В работе»

Особенности полей

Ограничения для 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

Для корректной работы статусов-стадий сортировка должна соблюдать порядок:

  1. Стадии группы «В работе»
  2. Стадия группы «Успех»
  3. Стадии группы «Провал»

Примеры кода

Как использовать примеры в документации

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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

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}")
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();
}
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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.status.add", b24.Params{
	"fields": b24.Params{
		"ENTITY_ID": "DEAL_STAGE_1",
		"STATUS_ID": "DECISION",
		"NAME":      "Принятие решения",
		"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("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)

Обработка ответа

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
integer

Идентификатор созданного элемента справочника

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

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

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Статус

Код

Описание

Значение

400

Пустое значение

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

Не передано обязательное поле ENTITY_ID или STATUS_ID. Если не переданы оба, обе строки приходят в одном ответе

400

Пустое значение

Parameter 'fields' must be array.

В параметр fields передан не объект

400

Пустое значение

Specified entity type is not supported.

В поле ENTITY_ID передан справочник, которого нет в CRM

400

Пустое значение

Не заполнено обязательное поле "Заголовок"

Не передано название элемента NAME

400

Пустое значение

Нельзя создать промежуточную стадию после успешной

Для справочника DEAL_STAGE в поле SORT указано значение больше, чем у стадии WON

400

Пустое значение

Access denied.

У пользователя нет права изменять настройки CRM

400

Пустое значение

Error on creating status.

Элемент справочника не создан, причину система не вернула

400

ERROR_CORE

Указанный идентификатор статуса, уже существует.

В справочнике ENTITY_ID уже есть элемент с таким STATUS_ID

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение