Обновить воронку

PATCH /v1/categories/:entityTypeId/:id

Обновляет поля существующей воронки указанного типа CRM-сущности. Передавайте только изменяемые поля плоско в корне JSON — без обёртки fields.

Параметры

Параметр Тип Обяз. Описание
entityTypeId (path) number да ID типа CRM-сущности. Для сделок 2, для счетов 31, для смарт-процесса — значение из GET /v1/smart-processes
id (path) number да Идентификатор воронки

Поля для обновления (body)

Поле Битрикс24 Тип Описание
name name string Название воронки
sort sort number Порядок сортировки среди воронок типа

Примеры

В примерах entityTypeId = 2 (сделки), id = 15 — замените на ваши значения.

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/categories/2/15" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Воронка партнёров — обновлено",
    "sort": 700
  }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/categories/2/15" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Воронка партнёров — обновлено",
    "sort": 700
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/categories/2/15', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Воронка партнёров — обновлено',
    sort: 700,
  }),
})

const { success, data } = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/categories/2/15', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Воронка партнёров — обновлено',
    sort: 700,
  }),
})

const { success, data } = await res.json()

Поля ответа

Возвращается полный объект воронки с применёнными изменениями.

Поле Тип Описание
id number Идентификатор воронки
entityTypeId number ID типа CRM-сущности, повторяет параметр пути
name string Название воронки
sort number Порядок сортировки
isDefault boolean Признак основной воронки типа
originId string Внешний идентификатор источника, пустая строка при отсутствии
originatorId string Идентификатор внешней системы, пустая строка при отсутствии

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

JSON 
{
  "success": true,
  "data": {
    "id": 15,
    "name": "Воронка партнёров — обновлено",
    "sort": 700,
    "entityTypeId": 2,
    "isDefault": false,
    "originId": "",
    "originatorId": ""
  }
}

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

404 — воронка с указанным id не найдена:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Элемент не найден"
  }
}

Ошибки

HTTP Код Описание
400 READONLY_FIELD Передано поле только для чтения — code или isDefault. Сообщение называет конкретное поле
404 ENTITY_NOT_FOUND Воронка с указанным id не найдена — сообщение Элемент не найден
404 ENTITY_NOT_FOUND entityTypeId не соответствует существующему типу — сообщение Смарт-процесс не найден
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

Известные особенности

Поля code и isDefault — только чтение. Передача code или isDefault в теле запроса возвращает 400 READONLY_FIELD — уберите эти поля из запроса. Основная воронка типа назначается в интерфейсе Битрикс24.

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