Обновить элемент смарт-процесса

PATCH /v1/items/:entityTypeId/:id

Обновляет поля элемента смарт-процесса. Передавайте только изменяемые поля.

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

Параметр Тип Описание
entityTypeId number ID типа смарт-процесса (в URL)
id number ID элемента (в URL)

Поля запроса (body)

Параметр Тип Описание
title string Название
stageId string Стадия. Список: GET /v1/statuses?filter[entityId]=DYNAMIC_{entityTypeId}_STAGE_{categoryId}
contactId number ID контакта
companyId number ID компании
opportunity number Сумма
currencyId string Валюта. Список: GET /v1/currencies
assignedById number Ответственный. Список: GET /v1/users
opened boolean Доступен для всех
begindate datetime Дата начала. Принимает ISO 8601, но сохраняется только дата — время отбрасывается
closedate datetime Дата завершения. Принимает ISO 8601, но сохраняется только дата — время отбрасывается
observers array ID наблюдателей

Полный список полей: GET /v1/items/:entityTypeId/fields. Пользовательские поля (ufCrmN_*) также принимаются.

Примеры

В примерах entityTypeId = 156, id = 783 — замените на ваши значения.

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

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/items/156/783 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "stageId": "DT156_41:WON",
    "opportunity": 750000
  }'

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

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/items/156/783 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "stageId": "DT156_41:WON",
    "opportunity": 750000
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/items/156/783', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    stageId: 'DT156_41:WON',
    opportunity: 750000,
  }),
})

const { success, data } = await res.json()
console.log('Обновлён:', data.id)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/items/156/783', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    stageId: 'DT156_41:WON',
    opportunity: 750000,
  }),
})

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

Поля ответа

Поле Тип Описание
id number ID элемента
title string Название
stageId string Стадия
opportunity number Сумма
assignedById number Ответственный
updatedBy number Последний редактор
updatedTime datetime Дата изменения

Ответ содержит все поля элемента после обновления.

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

JSON 
{
  "success": true,
  "data": {
    "id": 783,
    "title": "Договор на поставку",
    "stageId": "DT156_41:WON",
    "categoryId": 41,
    "companyId": 15,
    "contactId": 42,
    "opportunity": 750000,
    "currencyId": "RUB",
    "assignedById": 1,
    "createdBy": 1,
    "updatedBy": 1,
    "movedBy": 1,
    "createdTime": "2026-04-15T14:30:00+03:00",
    "updatedTime": "2026-04-15T16:45:00+03:00",
    "movedTime": "2026-04-15T16:45:00+03:00"
  }
}

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

404 — элемент не найден:

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

Ошибки

HTTP Код Описание
400 INVALID_DYNAMIC_PARAM entityTypeId не является положительным целым или является зарезервированным (1, 2, 3, 4, 7, 31)
400 READONLY_FIELD В теле передано поле только для чтения (id, createdTime, updatedTime и другие)
404 ENTITY_NOT_FOUND Элемент с указанным ID не найден
422 BITRIX_ERROR Ошибка валидации полей от Битрикс24. Конкретная причина — в поле message
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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