Для AI-агентов: markdown этой страницы — /docs-content/entities/deals/update.md индекс документации — /llms.txt

Обновить сделку

PATCH /v1/deals/:id

Обновляет поля существующей сделки. Передайте только изменяемые поля. Полный список — в справочнике полей.

Параметры

Параметр	Тип	Обяз.	Описание
`id` (path)	number	да	ID сделки. Список: `GET /v1/deals`

Часто обновляемые поля

Параметр	Тип	Обяз.	Описание
`stageId`	string	нет	Стадия воронки. Набор стадий у каждой воронки свой. Список: `GET /v1/statuses?filter[entityId]=DEAL_STAGE` для основной воронки, `DEAL_STAGE_{categoryId}` для остальных
`amount`	number	нет	Сумма сделки. Чтобы заданное вручную значение сохранилось, передайте вместе с ним `isManualOpportunity: true`
`assignedById`	number	нет	Ответственный. Список: `GET /v1/users`
`title`	string	нет	Название
`closedAt`	datetime	нет	Дата закрытия
`ufCrm*`	по схеме поля	нет	Пользовательское поле портала, например `ufCrmProjectCode`. Рабочее имя и тип — в схеме `GET /v1/deals/fields`, формат значения по типам — Пользовательские поля (UF). В поле типа `enumeration` записывается `ID` варианта из массива `items` этого поля в схеме, в множественное поле — массив таких `ID`. Подпись `VALUE` на месте `ID` теряется: поле с одним значением получает `0`. Число, которого нет среди вариантов, сохраняется как есть. Ни подпись, ни несуществующий `ID` не дают ошибки, ответ приходит с кодом `200`, поэтому сопоставляйте подпись с `ID` на своей стороне и сверяйте сохранённое значение по этому полю в `data` ответа

Примеры

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

Terminal

curl -X PATCH "https://vibecode.bitrix24.tech/v1/deals/741" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "stageId": "WON",
    "amount": 75000
  }'

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

Terminal

curl -X PATCH "https://vibecode.bitrix24.tech/v1/deals/741" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "stageId": "WON",
    "amount": 75000
  }'

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/deals/741', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    stageId: 'WON',
    amount: 75000,
  }),
})

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

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/deals/741', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    stageId: 'WON',
    amount: 75000,
  }),
})

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

Поля ответа

Поле	Тип	Описание
`data`	object	Обновлённый объект сделки со всеми полями — см. Поля
`meta.warnings`	array	Есть, когда в теле переданы поля, которых нет ни в схеме сделки, ни в списке полей `GET /v1/deals/fields`, например имя с опечаткой. Код предупреждения `UNRECOGNIZED_WRITE_FIELD`: такое поле могло не сохраниться. Ответ приходит с кодом `200`. Объект `fields` на маршруте, который сам оборачивает карту полей и где схема не объявляет `fields`, отклоняется с `400 NESTED_FIELDS_ENVELOPE`; передавайте поля плоско в корне JSON.

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

JSON

{
  "success": true,
  "data": {
    "id": 741,
    "title": "Поставка оборудования",
    "amount": 75000,
    "currency": "RUB",
    "stageId": "WON",
    "categoryId": 0,
    "assignedById": 1,
    "updatedAt": "2026-04-14T09:15:00.000Z"
  }
}

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

404 — сделка не найдена: