#Обновить запись справочника

PATCH /v1/statuses/:id

Обновляет поля записи справочника CRM по ID.

#Параметры пути

Параметр Тип Описание
id number ID записи справочника

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

Параметр Тип Описание
name string Название
sort number Порядок сортировки
color string Цвет (HEX без #)

#Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/statuses/42" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Предоплата получена", "sort": 35}'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/statuses/42" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Предоплата получена", "sort": 35}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/statuses/42', {
  method: 'PATCH',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({ name: 'Предоплата получена', sort: 35 }),
})
const { success, data } = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/statuses/42', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'Предоплата получена', sort: 35 }),
})
const { success, data } = await res.json()

#Поля ответа

Поле Тип Описание
data boolean true при успешном выполнении

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

JSON 
{
  "success": true,
  "data": true
}

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

JSON 
{
  "success": false,
  "error": { "code": "NOT_FOUND", "message": "Status not found" }
}

#Ошибки

HTTP Код Описание
404 NOT_FOUND Запись не найдена
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING Не передан API-ключ

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

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