#Создать запись справочника

POST /v1/statuses

Создаёт новую запись в справочнике CRM. Обязательные поля: entityId, statusId, name.

#Параметры тела запроса

Параметр Тип Обязат. Описание
entityId string да Тип справочника (DEAL_STAGE, SOURCE и др.)
statusId string да Символьный код значения
name string да Название
sort number Порядок сортировки
color string Цвет (HEX без #, напр. 22B9FF)
semantics string Семантика: S (успех), F (провал), P (в работе)

#Примеры

#curl — личный ключ

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/statuses" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"entityId": "SOURCE", "statusId": "PARTNER", "name": "Партнёр", "sort": 50}'

#curl — OAuth-приложение

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/statuses" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"entityId": "SOURCE", "statusId": "PARTNER", "name": "Партнёр", "sort": 50}'

#JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/statuses', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({ entityId: 'SOURCE', statusId: 'PARTNER', name: 'Партнёр', sort: 50 }),
})
const { success, data } = await res.json()
console.log('ID:', data.id)

#JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/statuses', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ entityId: 'SOURCE', statusId: 'PARTNER', name: 'Партнёр', sort: 50 }),
})
const { success, data } = await res.json()

#Поля ответа

Поле Тип Описание
id number ID записи
entityId string Тип справочника
statusId string Символьный код
name string Название
nameInit string Исходное название
sort number Сортировка
SYSTEM string Системная запись (Y/N)
CATEGORY_ID string/null ID категории
color string Цвет (HEX)
semantics string/null Семантика

#Пример ответа

JSON 
{
  "success": true,
  "data": {
    "id": 801,
    "entityId": "SOURCE",
    "statusId": "PARTNER",
    "name": "Партнёр",
    "nameInit": "",
    "sort": 50,
    "SYSTEM": "N",
    "CATEGORY_ID": "0",
    "color": "",
    "semantics": null
  }
}

#Пример ответа при ошибке

502 — дублирование кода:

JSON 
{
  "success": false,
  "error": { "code": "BITRIX_ERROR", "message": "Duplicate STATUS_ID for this ENTITY_ID" }
}

#Ошибки

HTTP Код Описание
502 BITRIX_ERROR Ошибка Bitrix24 (дублирование statusId и др.)
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING Не передан API-ключ

Полный список ошибок — Ошибки.

#Смотрите также