## Обновить лид

`PATCH /v1/leads/:id`

Обновляет поля существующего лида. Передайте только изменяемые поля. Полный список в [справочнике полей](/docs/entities/leads/fields), включая пользовательские (`ufCrm_*`).

> ⚠ **Важно про `email` / `phone` (multifield):** При обновлении Битрикс24 **только добавляет** новые multifield-записи. PATCH `{"email": "new@y.com"}` к лиду, у которого уже есть email, **не заменит** старый — у лида станет два email. Это особенность Битрикс24, не Вайбкод. Чтобы заменить или удалить email/phone — отредактируйте лид через интерфейс Битрикс24.

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

| Параметр | Тип | Описание |
|----------|-----|---------|
| `stageId` | string | Статус лида — каноническое имя, принимается и алиас `statusId`. Список: `GET /v1/statuses?filter[entityId]=STATUS`. В ответе значение возвращается в поле `stageId` |
| `opportunity` | number | Сумма — каноническое имя, принимается и алиас `amount`. ⚠ Чтобы значение сохранилось, передайте в том же запросе `isManualOpportunity: true` |
| `assignedById` | number | Ответственный. Список: `GET /v1/users` |
| `title` | string | Название лида |
| `phone` | string \| string[] \| object[] | Телефон. Принимает три формы: строка `"+7..."`, массив строк `["+7...", "+7..."]`, или массив объектов `[{ "value": "+7...", "typeId": "WORK" }, …]`. `typeId`: `WORK \| HOME \| MOBILE \| OTHER` (по умолчанию `WORK`). ⚠ UPPER-форма `[{ "VALUE": "...", "VALUE_TYPE": "WORK" }]` **не принимается** — вернёт `400 INVALID_MULTIFIELD_SHAPE`. Используйте camelCase: `[{ "value": "...", "typeId": "WORK" }]` |
| `email` | string \| string[] \| object[] | Email. Принимает три формы: строка `"a@b.com"`, массив строк `["a@b.com", "b@c.com"]`, или массив объектов `[{ "value": "a@b.com", "typeId": "WORK" }, …]`. `typeId`: `WORK \| HOME \| MAILING \| OTHER` (по умолчанию `WORK`). ⚠ UPPER-форма `[{ "VALUE": "...", "VALUE_TYPE": "WORK" }]` **не принимается** — вернёт `400 INVALID_MULTIFIELD_SHAPE`. Используйте camelCase: `[{ "value": "...", "typeId": "WORK" }]` |

## Примеры

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

```bash
curl -X PATCH "https://vibecode.bitrix24.tech/v1/leads/42" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "stageId": "IN_PROCESS",
    "opportunity": 250000,
    "isManualOpportunity": true,
    "assignedById": 3,
    "title": "Заявка с сайта — горячий клиент"
  }'
```

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

```bash
curl -X PATCH "https://vibecode.bitrix24.tech/v1/leads/42" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "stageId": "IN_PROCESS",
    "opportunity": 250000,
    "isManualOpportunity": true,
    "assignedById": 3,
    "title": "Заявка с сайта — горячий клиент"
  }'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/leads/42', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    stageId: 'IN_PROCESS',
    opportunity: 250000,
    isManualOpportunity: true,
    assignedById: 3,
    title: 'Заявка с сайта — горячий клиент',
  }),
})

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

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/leads/42', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    stageId: 'IN_PROCESS',
    opportunity: 250000,
    isManualOpportunity: true,
    assignedById: 3,
    title: 'Заявка с сайта — горячий клиент',
  }),
})

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

### Альтернативная форма — массив объектов с явным `typeId`

Если нужно указать несколько значений или явный тип (`HOME`, `MOBILE`):

```json
{
  "phone": [
    { "value": "+79161234567", "typeId": "WORK" },
    { "value": "+79161112233", "typeId": "MOBILE" }
  ],
  "email": [
    { "value": "work@company.ru", "typeId": "WORK" },
    { "value": "personal@me.ru", "typeId": "HOME" }
  ]
}
```

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `data` | object | Обновлённый объект лида со всеми полями — см. [Поля](/docs/entities/leads/fields) |

Обновленный объект лида — см. [Поля лида](/docs/entities/leads/fields).


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

```json
{
  "success": true,
  "data": {
    "id": 42,
    "title": "Заявка с сайта",
    "stageId": "IN_PROCESS",
    "assignedById": 1,
    "createdTime": "2026-04-15T12:00:00+03:00",
    "updatedTime": "2026-04-15T13:00:00+03:00"
  }
}
```

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

404 — лид не найден:

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

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 404 | `ENTITY_NOT_FOUND` | Лид не найден |
| 403 | `ACCESS_DENIED` | Нет доступа |
| 400 | `INVALID_MULTIFIELD_SHAPE` | Неверная форма поля `phone` или `email` — нужен `[{ "value", "typeId" }]` |
| 400 | `READONLY_FIELD` | Попытка записать read-only поле |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |

Полный список общих ошибок API — [Ошибки](/docs/errors).

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

- [Работа с файлами в полях CRM](/docs/recipes/crm-files)
- [Получить лид](/docs/entities/leads/get)
- [Поля лида](/docs/entities/leads/fields)
- [Статусы](/docs/entities/statuses)
- [Batch](/docs/batch)
- [Лимиты и оптимизация](/docs/optimization)