[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-entities\u002Fleads":3,"docs-tabs-entities\u002Fleads":6},{"content":4,"lastmod":5},"# Лиды\n\nУправление лидами CRM: создание, получение, обновление, удаление, фильтрация.\n\nBitrix24 API: `crm.item.*`\nСкоуп: `crm`\n\n## Операции\n\n- [Создать лид](.\u002Fleads\u002Fcreate.md) — `POST \u002Fv1\u002Fleads`\n- [Список лидов](.\u002Fleads\u002Flist.md) — `GET \u002Fv1\u002Fleads`\n- [Получить лид](.\u002Fleads\u002Fget.md) — `GET \u002Fv1\u002Fleads\u002F:id`\n- [Обновить лид](.\u002Fleads\u002Fupdate.md) — `PATCH \u002Fv1\u002Fleads\u002F:id`\n- [Удалить лид](.\u002Fleads\u002Fdelete.md) — `DELETE \u002Fv1\u002Fleads\u002F:id`\n- [Поиск лидов](.\u002Fleads\u002Fsearch.md) — `POST \u002Fv1\u002Fleads\u002Fsearch`\n- [Поля лида](.\u002Fleads\u002Ffields.md) — `GET \u002Fv1\u002Fleads\u002Ffields`\n- [Агрегация лидов](.\u002Fleads\u002Faggregate.md) — `POST \u002Fv1\u002Fleads\u002Faggregate`\n- [Получить товары](.\u002Fleads\u002Fproducts-get.md) — `GET \u002Fv1\u002Fleads\u002F:id\u002Fproducts`\n- [Установить товары](.\u002Fleads\u002Fproducts-set.md) — `PUT \u002Fv1\u002Fleads\u002F:id\u002Fproducts`\n- [Добавить товар](.\u002Fleads\u002Fproducts-add.md) — `POST \u002Fv1\u002Fleads\u002F:id\u002Fproducts`\n- [Удалить товар](.\u002Fleads\u002Fproducts-delete.md) — `DELETE \u002Fv1\u002Fleads\u002F:id\u002Fproducts\u002F:rowId`\n- [Получить товар](.\u002Fleads\u002Fproducts-get-single.md) — `GET \u002Fv1\u002Fleads\u002F:id\u002Fproducts\u002F:rowId`\n- [Обновить товар](.\u002Fleads\u002Fproducts-update.md) — `PATCH \u002Fv1\u002Fleads\u002F:id\u002Fproducts\u002F:rowId`\n- [Поля товаров](.\u002Fleads\u002Fproducts-fields.md) — `GET \u002Fv1\u002Fleads\u002F:id\u002Fproducts\u002Ffields`\n","2026-07-02",{"leads\u002Fcreate.md":7,"leads\u002Flist.md":8,"leads\u002Fget.md":9,"leads\u002Fupdate.md":10,"leads\u002Fdelete.md":11,"leads\u002Fsearch.md":12,"leads\u002Ffields.md":13,"leads\u002Faggregate.md":14,"leads\u002Fproducts-get.md":15,"leads\u002Fproducts-set.md":16,"leads\u002Fproducts-add.md":17,"leads\u002Fproducts-delete.md":18,"leads\u002Fproducts-get-single.md":19,"leads\u002Fproducts-update.md":20,"leads\u002Fproducts-fields.md":21},"\n## Создать лид\n\n`POST \u002Fv1\u002Fleads`\n\nСоздаёт новый лид в CRM.\n\n## Поля запроса (body)\n\n| Параметр | Тип | Описание |\n|----------|-----|---------|\n| `title` | string | Название лида |\n| `name` | string | Имя контакта |\n| `lastName` | string | Фамилия контакта |\n| `secondName` | string | Отчество |\n| `stageId` | string | Статус лида — каноническое имя, принимается и алиас `statusId`. Стандартные: `NEW`, `IN_PROCESS`, `PROCESSED`. Портал может иметь свои — список: `GET \u002Fv1\u002Fstatuses?filter[entityId]=STATUS`. В ответе значение возвращается в поле `stageId` |\n| `opportunity` | number | Сумма — каноническое имя, принимается и алиас `amount`. ⚠ Чтобы значение сохранилось, передайте в том же запросе `isManualOpportunity: true` — иначе Битрикс24 пересчитает сумму по товарным позициям |\n| `isManualOpportunity` | boolean | Ручной режим суммы (см. `opportunity`) |\n| `currency` | string | Валюта (алиас `currencyId`). Список: `GET \u002Fv1\u002Fcurrencies` |\n| `companyTitle` | string | Название компании (текст, не ID) |\n| `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\" }]` |\n| `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\" }]` |\n| `post` | string | Должность |\n| `comments` | string | Комментарий |\n| `sourceId` | string | Источник. Список: `GET \u002Fv1\u002Fstatuses?filter[entityId]=SOURCE` |\n| `sourceDescription` | string | Описание источника |\n| `assignedById` | number | Ответственный. Список: `GET \u002Fv1\u002Fusers` |\n| `opened` | boolean | Доступен для всех |\n\nПолный список полей: [GET \u002Fv1\u002Fleads\u002Ffields](\u002Fdocs\u002Fentities\u002Fleads\u002Ffields).\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X POST https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"title\": \"Заявка с сайта\",\n    \"name\": \"Мария\",\n    \"lastName\": \"Сидорова\",\n    \"phone\": \"+79161234567\",\n    \"sourceId\": \"WEB\",\n    \"stageId\": \"NEW\"\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X POST https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"title\": \"Заявка с сайта\",\n    \"name\": \"Мария\",\n    \"lastName\": \"Сидорова\",\n    \"phone\": \"+79161234567\",\n    \"sourceId\": \"WEB\",\n    \"stageId\": \"NEW\"\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    title: 'Заявка с сайта',\n    name: 'Мария',\n    lastName: 'Сидорова',\n    phone: '+79161234567',\n    sourceId: 'WEB',\n    stageId: 'NEW',\n  }),\n})\n\nconst { success, data } = await res.json()\nconsole.log('Lead ID:', data.id)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    title: 'Заявка с сайта',\n    name: 'Мария',\n    lastName: 'Сидорова',\n    phone: '+79161234567',\n    sourceId: 'WEB',\n    stageId: 'NEW',\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n### Альтернативная форма — массив объектов с явным `typeId`\n\nЕсли нужно указать несколько значений или явный тип (`HOME`, `MOBILE`):\n\n```json\n{\n  \"phone\": [\n    { \"value\": \"+79161234567\", \"typeId\": \"WORK\" },\n    { \"value\": \"+79161112233\", \"typeId\": \"MOBILE\" }\n  ],\n  \"email\": [\n    { \"value\": \"work@company.ru\", \"typeId\": \"WORK\" },\n    { \"value\": \"personal@me.ru\", \"typeId\": \"HOME\" }\n  ]\n}\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `id` | number | ID созданного лида |\n| `title` | string | Название |\n| `stageId` | string | Статус (стадия) лида |\n| `assignedById` | number | Ответственный |\n| `createdBy` | number | Создатель |\n| `createdTime` | datetime | Дата создания |\n\nОтвет содержит все поля лида.\n\nURL карточки лида в Битрикс24 строится из `id`:\n\n```\nhttps:\u002F\u002F\u003Cportal>.bitrix24.ru\u002Fcrm\u002Flead\u002Fdetails\u002F\u003Cid>\u002F\n```\n\n`\u003Cportal>` — домен портала. Доступ ограничен правами сотрудника в Битрикс24.\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 5001,\n    \"title\": \"Заявка с сайта\",\n    \"stageId\": \"NEW\",\n    \"assignedById\": 1,\n    \"createdBy\": 1,\n    \"createdTime\": \"2026-04-15T13:00:00+03:00\",\n    \"updatedTime\": \"2026-04-15T13:00:00+03:00\",\n    \"opened\": true,\n    \"sourceId\": \"WEB\"\n  }\n}\n```\n\n## Пример ответа при ошибке\n\n403 — нет скоупа:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"SCOPE_DENIED\",\n    \"message\": \"This endpoint requires 'crm' scope\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n| 400 | `INVALID_MULTIFIELD_SHAPE` | Неверная форма поля `phone` или `email` — нужен `[{ \"value\", \"typeId\" }]` |\n| 400 | `READONLY_FIELD` | Попытка записать read-only поле |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**Конвертация лида:** Битрикс24 REST не имеет отдельного метода конвертации. Чтобы «конвертировать» лид, создайте сделку\u002Fконтакт\u002Fкомпанию с `leadId` и обновите статус лида:\n\n```javascript\n\u002F\u002F 1. Создать сделку из лида\nawait fetch('\u002Fv1\u002Fdeals', { body: { title: 'Из лида', leadId: 5001 } })\n\u002F\u002F 2. Закрыть лид\nawait fetch('\u002Fv1\u002Fleads\u002F5001', { method: 'PATCH', body: { statusId: 'CONVERTED' } })\n```\n\n## Смотрите также\n\n- [Работа с файлами в полях CRM](\u002Fdocs\u002Frecipes\u002Fcrm-files)\n- [Список лидов](\u002Fdocs\u002Fentities\u002Fleads\u002Flist)\n- [Поля лида](\u002Fdocs\u002Fentities\u002Fleads\u002Ffields)\n- [Поиск дубликатов](\u002Fdocs\u002Fduplicates)\n- [Сделки](\u002Fdocs\u002Fentities\u002Fdeals)\n- [Entity API](\u002Fdocs\u002Fentity-api)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization)\n","\n## Список лидов\n\n`GET \u002Fv1\u002Fleads`\n\nВозвращает список лидов с поддержкой фильтрации, сортировки и авто-пагинации.\n\n## Параметры\n\n| Параметр | Тип | По умолч. | Описание |\n|----------|-----|-----------|---------|\n| `limit` | number | `50` | Количество записей (до 5000). При `limit > 50` авто-пагинация |\n| `offset` | number | `0` | Пропустить N записей. При `offset > 0` рекомендуется `limit \u003C= 500` |\n| `select` | string | — | Выборка полей: `?select=id,title,stageId,amount`. Неизвестные поля игнорируются |\n| `order` | object | — | Сортировка: `?order[createdTime]=desc`. Имена для сортировки — из `GET \u002Fv1\u002Fleads\u002Ffields` |\n| `filter` | object | — | Фильтрация по полям `GET \u002Fv1\u002Fleads\u002Ffields`.\u003Cbr>[Синтаксис фильтрации](\u002Fdocs\u002Ffiltering). Пример: `?filter[stageId]=NEW` |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads?limit=10&filter[stageId]=NEW&select=id,title,stageId,amount\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads?limit=10&filter[stageId]=NEW&select=id,title,stageId,amount\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads?limit=10&filter[stageId]=NEW&select=id,title,stageId,amount', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { success, data, meta } = await res.json()\nconsole.log(`Найдено ${meta.total} лидов`)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads?limit=10&filter[stageId]=NEW&select=id,title,stageId,amount', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { success, data, meta } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `data` | array | Массив лидов (поля — см. [Поля](\u002Fdocs\u002Fentities\u002Fleads\u002Ffields)) |\n| `meta.total` | number | Общее количество записей |\n| `meta.hasMore` | boolean | Есть ещё записи |\n\nURL карточки любого лида из массива `data` — его `id`:\n\n```\nhttps:\u002F\u002F\u003Cportal>.bitrix24.ru\u002Fcrm\u002Flead\u002Fdetails\u002F\u003Cid>\u002F\n```\n\n`\u003Cportal>` — домен портала. Доступ ограничен правами сотрудника в Битрикс24.\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 42,\n      \"title\": \"Заявка с сайта #42\",\n      \"name\": \"Алексей\",\n      \"lastName\": \"Иванов\",\n      \"stageId\": \"NEW\",\n      \"opportunity\": 150000,\n      \"currencyId\": \"RUB\",\n      \"assignedById\": 1,\n      \"sourceId\": \"WEB\",\n      \"createdTime\": \"2026-04-10T14:30:00+03:00\"\n    }\n  ],\n  \"meta\": {\n    \"total\": 834,\n    \"hasMore\": true\n  }\n}\n```\n\n## Пример ответа при ошибке\n\n403 — нет скоупа:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"SCOPE_DENIED\",\n    \"message\": \"This endpoint requires 'crm' scope\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**Фильтр по телефону подходит не для всякого поиска.** Значение без оператора сравнивается со всей сохранённой строкой: лид с номером `+7 (999) 123-45-67` найдётся по этой же строке и не найдётся по `79991234567`, потому что плюс, пробелы, скобки и дефисы — часть значения. Вдобавок фильтр видит только первый номер записи: если записаны рабочий и мобильный, по мобильному он вернёт пустой список. Чтобы найти лид по номеру телефона в любом написании и по любому из его номеров, используйте [Поиск дубликатов](\u002Fdocs\u002Fduplicates).\n\n**Авто-пагинация:** при `limit > 50` Вайбкод автоматически запрашивает несколько страниц.\n\n**Когда использовать search:** для сложных фильтров — `POST \u002Fv1\u002Fleads\u002Fsearch`, параметры передаются в body. См. [Поиск лидов](\u002Fdocs\u002Fentities\u002Fleads\u002Fsearch).\n\n## Смотрите также\n\n- [Поиск лидов](\u002Fdocs\u002Fentities\u002Fleads\u002Fsearch)\n- [Поля лида](\u002Fdocs\u002Fentities\u002Fleads\u002Ffields)\n- [Поиск дубликатов](\u002Fdocs\u002Fduplicates)\n- [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering)\n- [Batch](\u002Fdocs\u002Fbatch)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization)\n","\n## Получить лид\n\n`GET \u002Fv1\u002Fleads\u002F:id`\n\nВозвращает лид по ID со всеми полями. \n\n## Параметры\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `id` (path) | number | да | ID лида |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F42\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F42\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F42', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { success, data } = await res.json()\nconsole.log('Лид:', data.title, '— статус:', data.stageId)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F42', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { success, data } = await res.json()\n```\n\n## Поля ответа\n\nОбъект лида со всеми полями — см. [Поля лида](\u002Fdocs\u002Fentities\u002Fleads\u002Ffields).\n\n## Связанные данные\n\nЗапрос со связанными сущностями — параметр `include`:\n\n```\nGET \u002Fv1\u002Fleads\u002F5001?include=contact,company\n```\n\nДоступные include: `contact`, `company`. Результат в поле `_included`. Подробнее — [Связанные данные](\u002Fdocs\u002Fincludes).\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 42,\n    \"title\": \"Заявка с сайта #42\",\n    \"name\": \"Алексей\",\n    \"lastName\": \"Иванов\",\n    \"secondName\": \"Петрович\",\n    \"stageId\": \"NEW\",\n    \"companyTitle\": \"ООО Ромашка\",\n    \"companyId\": 15,\n    \"contactId\": 71,\n    \"opportunity\": 150000,\n    \"currencyId\": \"RUB\",\n    \"sourceId\": \"WEB\",\n    \"sourceDescription\": \"Форма обратной связи\",\n    \"assignedById\": 1,\n    \"createdBy\": 1,\n    \"opened\": true,\n    \"comments\": \"Звонить после 14:00\",\n    \"phone\": \"+70000000001\",\n    \"phoneWork\": \"+70000000001\",\n    \"email\": \"info@example.com\",\n    \"emailWork\": \"info@example.com\",\n    \"emailHome\": \"home@example.com\",\n    \"hasPhone\": true,\n    \"hasEmail\": true,\n    \"fm\": [\n      { \"id\": 41, \"typeId\": \"PHONE\", \"valueType\": \"WORK\", \"value\": \"+70000000001\" },\n      { \"id\": 43, \"typeId\": \"EMAIL\", \"valueType\": \"WORK\", \"value\": \"info@example.com\" },\n      { \"id\": 45, \"typeId\": \"EMAIL\", \"valueType\": \"HOME\", \"value\": \"home@example.com\" }\n    ],\n    \"createdTime\": \"2026-04-10T14:30:00+03:00\",\n    \"updatedTime\": \"2026-04-12T09:15:00+03:00\"\n  }\n}\n```\n\nТелефон и почта в ответе — строки с первичным значением, значения по типам — в полях `phoneWork`, `phoneMobile`, `emailWork`, `emailHome`. Полный перечень с типами — в массиве `fm[]` (`{ id, typeId, valueType, value }`, где `id` — идентификатор записи). Наличие проверяйте по `hasPhone`\u002F`hasEmail`: при отсутствии телефона `phone` приходит пустой строкой. Отдельную запись `fm[]` по её `id` через API не изменить и не удалить — PATCH добавляет новые записи.\n\n## Пример ответа при ошибке\n\n404 — лид не найден:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Элемент не найден\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 404 | `ENTITY_NOT_FOUND` | Лид не найден |\n| 403 | `ACCESS_DENIED` | Нет доступа к лиду |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Работа с файлами в полях CRM](\u002Fdocs\u002Frecipes\u002Fcrm-files)\n- [Обновить лид](\u002Fdocs\u002Fentities\u002Fleads\u002Fupdate)\n- [Поля лида](\u002Fdocs\u002Fentities\u002Fleads\u002Ffields)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization)\n","\n## Обновить лид\n\n`PATCH \u002Fv1\u002Fleads\u002F:id`\n\nОбновляет поля существующего лида. Передайте только изменяемые поля. Полный список в [справочнике полей](\u002Fdocs\u002Fentities\u002Fleads\u002Ffields), включая пользовательские (`ufCrm_*`).\n\n> ⚠ **Важно про `email` \u002F `phone` (multifield):** При обновлении Битрикс24 **только добавляет** новые multifield-записи. PATCH `{\"email\": \"new@y.com\"}` к лиду, у которого уже есть email, **не заменит** старый — у лида станет два email. Это особенность Битрикс24, не Вайбкод. Чтобы заменить или удалить email\u002Fphone — отредактируйте лид через интерфейс Битрикс24.\n\n## Часто обновляемые поля\n\n| Параметр | Тип | Описание |\n|----------|-----|---------|\n| `stageId` | string | Статус лида — каноническое имя, принимается и алиас `statusId`. Список: `GET \u002Fv1\u002Fstatuses?filter[entityId]=STATUS`. В ответе значение возвращается в поле `stageId` |\n| `opportunity` | number | Сумма — каноническое имя, принимается и алиас `amount`. ⚠ Чтобы значение сохранилось, передайте в том же запросе `isManualOpportunity: true` |\n| `assignedById` | number | Ответственный. Список: `GET \u002Fv1\u002Fusers` |\n| `title` | string | Название лида |\n| `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\" }]` |\n| `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\" }]` |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X PATCH \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F42\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"stageId\": \"IN_PROCESS\",\n    \"opportunity\": 250000,\n    \"isManualOpportunity\": true,\n    \"assignedById\": 3,\n    \"title\": \"Заявка с сайта — горячий клиент\"\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X PATCH \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F42\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"stageId\": \"IN_PROCESS\",\n    \"opportunity\": 250000,\n    \"isManualOpportunity\": true,\n    \"assignedById\": 3,\n    \"title\": \"Заявка с сайта — горячий клиент\"\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F42', {\n  method: 'PATCH',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    stageId: 'IN_PROCESS',\n    opportunity: 250000,\n    isManualOpportunity: true,\n    assignedById: 3,\n    title: 'Заявка с сайта — горячий клиент',\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F42', {\n  method: 'PATCH',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    stageId: 'IN_PROCESS',\n    opportunity: 250000,\n    isManualOpportunity: true,\n    assignedById: 3,\n    title: 'Заявка с сайта — горячий клиент',\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n### Альтернативная форма — массив объектов с явным `typeId`\n\nЕсли нужно указать несколько значений или явный тип (`HOME`, `MOBILE`):\n\n```json\n{\n  \"phone\": [\n    { \"value\": \"+79161234567\", \"typeId\": \"WORK\" },\n    { \"value\": \"+79161112233\", \"typeId\": \"MOBILE\" }\n  ],\n  \"email\": [\n    { \"value\": \"work@company.ru\", \"typeId\": \"WORK\" },\n    { \"value\": \"personal@me.ru\", \"typeId\": \"HOME\" }\n  ]\n}\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `data` | object | Обновлённый объект лида со всеми полями — см. [Поля](\u002Fdocs\u002Fentities\u002Fleads\u002Ffields) |\n\nОбновленный объект лида — см. [Поля лида](\u002Fdocs\u002Fentities\u002Fleads\u002Ffields).\n\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 42,\n    \"title\": \"Заявка с сайта\",\n    \"stageId\": \"IN_PROCESS\",\n    \"assignedById\": 1,\n    \"createdTime\": \"2026-04-15T12:00:00+03:00\",\n    \"updatedTime\": \"2026-04-15T13:00:00+03:00\"\n  }\n}\n```\n\n## Пример ответа при ошибке\n\n404 — лид не найден:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Элемент не найден\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 404 | `ENTITY_NOT_FOUND` | Лид не найден |\n| 403 | `ACCESS_DENIED` | Нет доступа |\n| 400 | `INVALID_MULTIFIELD_SHAPE` | Неверная форма поля `phone` или `email` — нужен `[{ \"value\", \"typeId\" }]` |\n| 400 | `READONLY_FIELD` | Попытка записать read-only поле |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Работа с файлами в полях CRM](\u002Fdocs\u002Frecipes\u002Fcrm-files)\n- [Получить лид](\u002Fdocs\u002Fentities\u002Fleads\u002Fget)\n- [Поля лида](\u002Fdocs\u002Fentities\u002Fleads\u002Ffields)\n- [Статусы](\u002Fdocs\u002Fentities\u002Fstatuses)\n- [Batch](\u002Fdocs\u002Fbatch)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization)\n","\n## Удалить лид\n\n`DELETE \u002Fv1\u002Fleads\u002F:id`\n\nУдаляет лид по ID. Восстановить удалённый лид через API нельзя — создавайте новый при необходимости.\n\n## Параметры\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `id` (path) | number | да | ID лида |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X DELETE \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F42\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X DELETE \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F42\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F42', {\n  method: 'DELETE',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nif (res.status === 204) {\n  console.log('Лид удалён')\n}\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F42', {\n  method: 'DELETE',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nif (res.status === 204) {\n  console.log('Удалено')\n}\n```\n\n## Ответ\n\nПри успешном удалении возвращается HTTP-статус `204 No Content` с пустым телом — признак успеха проверяется по статусу.\n\n## Пример ответа\n\n```\nHTTP\u002F1.1 204 No Content\n```\n\n## Пример ответа при ошибке\n\n404 — лид не найден:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Элемент не найден\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 404 | `ENTITY_NOT_FOUND` | Лид не найден |\n| 403 | `ACCESS_DENIED` | Нет доступа |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Список лидов](\u002Fdocs\u002Fentities\u002Fleads\u002Flist)\n- [Batch](\u002Fdocs\u002Fbatch)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization)\n","\n## Поиск лидов\n\n`POST \u002Fv1\u002Fleads\u002Fsearch`\n\nПоиск лидов по условиям в теле запроса. Принимает те же фильтры, что и список лидов, и рассчитан на составные условия и большие выборки.\n\n## Поля запроса (body)\n\n| Параметр | Тип | По умолч. | Описание |\n|----------|-----|-----------|---------|\n| `filter` | object | — | Фильтрация по полям `GET \u002Fv1\u002Fleads\u002Ffields`.\u003Cbr>[Синтаксис фильтрации](\u002Fdocs\u002Ffiltering). Пример: `{ \"stageId\": \"NEW\" }` |\n| `limit` | number | `50` | Количество записей (до 5000) |\n| `offset` | number | `0` | Пропустить N записей |\n| `order` | object | — | Сортировка: `{ \"createdTime\": \"desc\" }` |\n| `select` | string[] | — | Выборка полей: `[\"id\", \"title\", \"stageId\", \"amount\"]` |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002Fsearch\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"filter\": { \"stageId\": \"NEW\", \">=amount\": 100000 },\n    \"limit\": 10,\n    \"order\": { \"createdTime\": \"desc\" }\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002Fsearch\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"filter\": { \"stageId\": \"NEW\", \">=amount\": 100000 },\n    \"limit\": 10,\n    \"order\": { \"createdTime\": \"desc\" }\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002Fsearch', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    filter: { stageId: 'NEW', '>=amount': 100000 },\n    limit: 10,\n    order: { createdTime: 'desc' },\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002Fsearch', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    filter: { stageId: 'NEW', '>=amount': 100000 },\n    limit: 10,\n    order: { createdTime: 'desc' },\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `data` | array | Массив лидов (поля — см. [Поля](\u002Fdocs\u002Fentities\u002Fleads\u002Ffields)) |\n\nURL карточки любого лида из массива `data` — его `id`:\n\n```\nhttps:\u002F\u002F\u003Cportal>.bitrix24.ru\u002Fcrm\u002Flead\u002Fdetails\u002F\u003Cid>\u002F\n```\n\n`\u003Cportal>` — домен портала. Доступ ограничен правами сотрудника в Битрикс24.\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 42,\n      \"title\": \"Заявка с сайта #42\",\n      \"stageId\": \"NEW\",\n      \"opportunity\": 150000,\n      \"currencyId\": \"RUB\",\n      \"assignedById\": 1,\n      \"sourceId\": \"WEB\",\n      \"createdTime\": \"2026-04-10T14:30:00+03:00\"\n    }\n  ]\n}\n```\n\n## Пример ответа при ошибке\n\n403 — нет скоупа:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"SCOPE_DENIED\",\n    \"message\": \"This endpoint requires 'crm' scope\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**Фильтр по телефону подходит не для всякого поиска.** Значение без оператора сравнивается со всей сохранённой строкой: лид с номером `+7 (999) 123-45-67` найдётся по этой же строке и не найдётся по `79991234567`, потому что плюс, пробелы, скобки и дефисы — часть значения. Вдобавок фильтр видит только первый номер записи: если записаны рабочий и мобильный, по мобильному он вернёт пустой список. Чтобы найти лид по номеру телефона в любом написании и по любому из его номеров, используйте [Поиск дубликатов](\u002Fdocs\u002Fduplicates). Оператор `$contains` при этом работает — он ищет кусок текста внутри значения, это рабочий способ для почты: `{ \"email\": { \"$contains\": \"@example.com\" } }`.\n\n## Смотрите также\n\n- [Список лидов](\u002Fdocs\u002Fentities\u002Fleads\u002Flist)\n- [Поиск дубликатов](\u002Fdocs\u002Fduplicates)\n- [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering)\n- [Batch](\u002Fdocs\u002Fbatch)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization)\n","\n## Поля лида\n\n`GET \u002Fv1\u002Fleads\u002Ffields`\n\nВозвращает полный список доступных полей, включая пользовательские (`ufCrm_*`).\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002Ffields\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002Ffields\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002Ffields', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { success, data } = await res.json()\nconsole.log('Полей:', Object.keys(data).length)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002Ffields', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { success, data } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | RO | Описание |\n|------|-----|:--:|---------|\n| `id` | number | да | ID лида |\n| `title` | string | | Название лида |\n| `name` | string | | Имя |\n| `lastName` | string | | Фамилия |\n| `secondName` | string | | Отчество |\n| `stageId` | string | | Статус (стадия) лида — каноническое имя в ответах: `NEW`, `IN_PROCESS`, … Список: `GET \u002Fv1\u002Fstatuses?filter[entityId]=STATUS` |\n| `statusId` | string | | Алиас `stageId` на запись, в фильтрах и сортировке. ⚠ В ответах list\u002Fget\u002Fsearch значение приходит в поле `stageId`, ключ `statusId` в ответе не возвращается — читайте `stageId`. Не передавайте алиас и каноническое имя одновременно в одном запросе |\n| `companyTitle` | string | | Название компании |\n| `companyId` | number | | ID компании. Поиск: `GET \u002Fv1\u002Fcompanies` |\n| `contactId` | number | | ID контакта. Поиск: `GET \u002Fv1\u002Fcontacts` |\n| `opportunity` | number | | Сумма — каноническое имя в ответах. ⚠ Чтобы записанное значение сохранилось, передайте `isManualOpportunity: true` в том же запросе |\n| `amount` | number | | Алиас `opportunity` на запись\u002Fв фильтрах. В ответах значение приходит в поле `opportunity` |\n| `isManualOpportunity` | boolean | | Ручной режим суммы. Без `true` сумма пересчитывается по товарным позициям и записанное значение затирается |\n| `currency` | string | | Алиас `currencyId` на запись\u002Fв фильтрах. Валюта. Список: `GET \u002Fv1\u002Fcurrencies` |\n| `currencyId` | string | | Валюта — каноническое имя в ответах |\n| `sourceId` | string | | Источник. Список: `GET \u002Fv1\u002Fstatuses?filter[entityId]=SOURCE` |\n| `sourceDescription` | string | | Описание источника |\n| `assignedById` | number | | Ответственный. Список: `GET \u002Fv1\u002Fusers` |\n| `createdBy` | number | да | Создатель. Поиск: `GET \u002Fv1\u002Fusers` |\n| `opened` | boolean | | Доступен для всех |\n| `comments` | string | | Комментарий |\n| `post` | string | | Должность |\n| `phone` | multifield | | Телефон. На вход (POST\u002FPATCH) принимает `string \\| string[] \\| object[]`. На выходе `phone` — строка с первичным значением, значения по типам — в полях `phoneWork`\u002F`phoneMobile`, полный перечень с типами — в массиве `fm[]` (формат `{ id, typeId, valueType, value }`). ⚠ PATCH **только добавляет** новые записи — старые `phone` не удаляются. См. [Обновить лид](\u002Fdocs\u002Fentities\u002Fleads\u002Fupdate). ⚠ UPPER-форма `[{ \"VALUE\": \"...\", \"VALUE_TYPE\": \"WORK\" }]` **не принимается** — вернёт `400 INVALID_MULTIFIELD_SHAPE`. Используйте camelCase: `[{ \"value\": \"...\", \"typeId\": \"WORK\" }]`. |\n| `email` | multifield | | Email. На вход принимает `string \\| string[] \\| object[]`. На выходе `email` — строка с первичным значением, значения по типам — в полях `emailWork`\u002F`emailHome`\u002F`emailMailing`, полный перечень — в массиве `fm[]`. ⚠ PATCH **только добавляет** новые записи — старые `email` не удаляются. ⚠ UPPER-форма `[{ \"VALUE\": \"...\", \"VALUE_TYPE\": \"WORK\" }]` **не принимается** — вернёт `400 INVALID_MULTIFIELD_SHAPE`. Используйте camelCase: `[{ \"value\": \"...\", \"typeId\": \"WORK\" }]`. |\n| `birthdate` | datetime | | Дата рождения |\n| `hasPhone` | boolean | да | Указан ли телефон |\n| `hasEmail` | boolean | да | Указан ли email |\n| `hasImol` | boolean | да | Есть ли контакт в открытой линии |\n| `isReturnCustomer` | boolean | да | Повторное обращение |\n| `createdTime` | datetime | да | Дата создания |\n| `updatedTime` | datetime | да | Дата изменения |\n| `originatorId` | string | | Внешний источник — идентификатор внешней системы, из которой импортирован лид; `null` для лидов, созданных в Bitrix24 |\n| `dateClosed` | datetime | да | Дата закрытия лида; `null`, пока лид не закрыт |\n| `lastCommunicationTime` | string | да | Дата последней коммуникации с лидом; `null`, если её не было |\n| `utmSource` | string | | Метка `utm_source` источника трафика; `null`, если не задана |\n| `utmMedium` | string | | Метка `utm_medium` источника трафика; `null`, если не задана |\n| `utmCampaign` | string | | Метка `utm_campaign` источника трафика; `null`, если не задана |\n| `utmContent` | string | | Метка `utm_content` источника трафика; `null`, если не задана |\n| `utmTerm` | string | | Метка `utm_term` источника трафика; `null`, если не задана |\n\n**Пользовательские поля** (`ufCrm_*`) также возвращаются в ответах и принимаются при создании\u002Fобновлении.\n\n\n\n## Доступные include\n\nЭндпоинт `GET \u002Fv1\u002Fleads\u002Ffields` возвращает список доступных include: `contact`, `company`.\n\nПример использования: [Получить leads](\u002Fdocs\u002Fentities\u002Fleads\u002Fget#связанные-данные).\n\nПодробнее об include: [Связанные данные](\u002Fdocs\u002Fincludes).\n\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"fields\": {\n      \"id\": { \"type\": \"number\", \"readonly\": true },\n      \"title\": { \"type\": \"string\", \"readonly\": false },\n      \"assignedById\": { \"type\": \"number\", \"readonly\": false }\n    },\n    \"batch\": [\"create\", \"update\", \"delete\"]\n  }\n}\n```\n\nПоказаны 3 из множества полей. Полный список в таблице выше.\n\n## Пример ответа при ошибке\n\n404 — не найден:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Элемент не найден\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Обновить лид](\u002Fdocs\u002Fentities\u002Fleads\u002Fupdate)\n- [Сделки](\u002Fdocs\u002Fentities\u002Fdeals)\n- [Пользовательские поля](\u002Fdocs\u002Fuserfields)\n- [Entity API](\u002Fdocs\u002Fentity-api)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization)\n","\n## Агрегация лидов\n\n`POST \u002Fv1\u002Fleads\u002Faggregate`\n\nПодсчёт количества, сумма, среднее, минимум и максимум по лидам с фильтрацией и группировкой.\n\n**Стандартные поля:**\n\n- `opportunity` — сумма, каноническое имя, алиас `amount`. Числовые функции и `groupBy`\n- `stageId` — статус, каноническое имя, алиас `statusId`. Для `groupBy`\n- `sourceId` — источник. Для `groupBy`\n- `assignedById` — ответственный. Для `groupBy`\n\n**Пользовательские поля (UF):** UF-поля типов `integer`, `double`, `money` — для числовых функций. UF любого типа — для `groupBy`. Полный список UF-полей конкретного портала приходит в тексте ошибки `INVALID_PARAMS`, если передать несуществующее имя.\n\n## Поля запроса (body)\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `aggregate` | array | нет | Массив агрегаций. Каждый элемент: `{ \"field\": \"amount\", \"function\": \"sum\" }`. Функции: `count`, `sum`, `avg`, `min`, `max`. Для `count` поле — `\"*\"`. Без массива — только `count` |\n| `filter` | object | нет | Фильтрация по полям `GET \u002Fv1\u002Fleads\u002Ffields`. [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering) |\n| `groupBy` | string \\| string[] | нет | Поле или массив полей для группировки (максимум 5). Допустимые значения — из списка выше |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002Faggregate\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"aggregate\": [\n      { \"field\": \"amount\", \"function\": \"sum\" },\n      { \"field\": \"amount\", \"function\": \"avg\" }\n    ],\n    \"filter\": { \"sourceId\": \"WEB\" },\n    \"groupBy\": \"statusId\"\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002Faggregate\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"aggregate\": [\n      { \"field\": \"amount\", \"function\": \"sum\" },\n      { \"field\": \"amount\", \"function\": \"avg\" }\n    ],\n    \"filter\": { \"sourceId\": \"WEB\" },\n    \"groupBy\": \"statusId\"\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002Faggregate', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    aggregate: [\n      { field: 'amount', function: 'sum' },\n      { field: 'amount', function: 'avg' },\n    ],\n    filter: { sourceId: 'WEB' },\n    groupBy: 'statusId',\n  }),\n})\n\nconst { success, data } = await res.json()\nconsole.log('Всего лидов:', data.count)\nconsole.log('По статусам:', data.groups)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002Faggregate', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    aggregate: [\n      { field: 'amount', function: 'sum' },\n      { field: 'amount', function: 'avg' },\n    ],\n    filter: { sourceId: 'WEB' },\n    groupBy: 'statusId',\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n> Для группировки по нескольким полям передайте массив: `\"groupBy\": [\"statusId\", \"sourceId\"]` (максимум 5).\n\n## Другие сценарии\n\nПодсчёт записей — `count` с полем `\"*\"`, самый быстрый запрос без выгрузки записей. Без массива `aggregate` результат тот же:\n\n```json\n{ \"aggregate\": [{ \"field\": \"*\", \"function\": \"count\" }] }\n```\n\nРабота с пользовательскими полями (UF) — `sum` по UF + группировка по другому UF:\n\n```json\n{\n  \"aggregate\": [{ \"field\": \"UF_CRM_BUDGET\", \"function\": \"sum\" }],\n  \"groupBy\": \"UF_CRM_PRIORITY\"\n}\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `success` | boolean | Всегда `true` при успехе |\n| `data.count` | number | Общее количество записей под фильтр |\n| `data.aggregates` | object | Результаты агрегаций: `{ \"amount\": { \"sum\": 500000, \"avg\": 5000 } }` |\n| `data.groups` | array | Группы (только при `groupBy`). Каждый элемент: поля группировки + `count` + `aggregates` |\n| `data.meta.totalRecords` | number | Общее количество записей под фильтр |\n| `data.meta.recordsProcessed` | number | Сколько записей обработано для числовых агрегаций (максимум 5000) |\n| `data.meta.truncated` | boolean | `true`, если под фильтр попало больше 5000 записей |\n\n## Пример ответа\n\nОтвет на основной запрос (агрегации + `groupBy: \"statusId\"`):\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"count\": 100,\n    \"aggregates\": {\n      \"amount\": { \"sum\": 500000, \"avg\": 5000 }\n    },\n    \"groups\": [\n      {\n        \"statusId\": \"NEW\",\n        \"count\": 60,\n        \"aggregates\": { \"amount\": { \"sum\": 300000 } }\n      },\n      {\n        \"statusId\": \"CONVERTED\",\n        \"count\": 40,\n        \"aggregates\": { \"amount\": { \"sum\": 200000 } }\n      }\n    ],\n    \"meta\": {\n      \"totalRecords\": 100,\n      \"recordsProcessed\": 100,\n      \"truncated\": false\n    }\n  }\n}\n```\n\nБез `groupBy` поле `data.groups` в ответе отсутствует.\n\n## Пример ответа при ошибке\n\n400 — неверное имя функции, несуществующее поле или `groupBy` по неаггрегируемому полю:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INVALID_PARAMS\",\n    \"message\": \"Field 'foo' not found. Available numeric fields: stageId, statusId, opportunity, amount, sourceId, assignedById\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `INVALID_PARAMS` | Некорректное имя функции, несуществующее поле, нечисловое поле в `sum`\u002F`avg`\u002F`min`\u002F`max`, `groupBy` по неаггрегируемому полю или больше 5 полей в `groupBy` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**`count` vs числовые функции.** `count` считается одним вызовом в Битрикс24 на любом объёме данных. Функции `sum`\u002F`avg`\u002F`min`\u002F`max` подгружают записи постранично (максимум 5000) и считают на стороне Вайбкод — если под фильтр попадает больше 5000 записей, `meta.truncated` будет `true`, агрегация выполнится по первым 5000. Для точных счётчиков на больших выборках используйте `count` или сужайте фильтр.\n\n**Money-поля.** UF-поля типа `money` хранятся в формате `\"сумма|валюта\"` (`\"1500|RUB\"`) — агрегат извлекает числовую часть автоматически, складывать можно без парсинга.\n\n**Фильтрация по UF работает.** В `filter` можно передавать любые поля — стандартные и пользовательские, любого типа. Например, `{ \"filter\": { \"ufCrm_1234\": \"value\" } }` вернёт количество лидов с этим значением UF.\n\n## Смотрите также\n\n- [Список лидов](\u002Fdocs\u002Fentities\u002Fleads\u002Flist)\n- [Поиск лидов](\u002Fdocs\u002Fentities\u002Fleads\u002Fsearch)\n- [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization)\n","\n## Товарные позиции лида\n\n`GET \u002Fv1\u002Fleads\u002F:id\u002Fproducts`\n\nВозвращает список товарных позиций, привязанных к лиду.\n\n## Параметры\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `id` (path) | number | да | ID лида |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F741\u002Fproducts\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F741\u002Fproducts\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F741\u002Fproducts', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { success, data } = await res.json()\nconsole.log('Товаров:', data.length)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F741\u002Fproducts', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { success, data } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `data` | array | Массив товарных позиций |\n| `data[].productId` | number | ID товара. Каталог: `GET \u002Fv1\u002Fproducts` |\n| `data[].productName` | string | Название товара |\n| `data[].price` | number | Цена за единицу |\n| `data[].quantity` | number | Количество |\n| `data[].discount` | number | Сумма скидки |\n| `data[].taxRate` | number\u002Fnull | Ставка налога (%) |\n| `data[].taxIncluded` | boolean | Налог включён в цену |\n\nПоказаны основные поля. Полный список (20 полей, включая priceAccount, measureCode и др.): [Поля товаров](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-fields).\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"productId\": 1,\n      \"productName\": \"Серверное оборудование\",\n      \"price\": 1000,\n      \"quantity\": 2,\n      \"discount\": 0,\n      \"taxRate\": null,\n      \"taxIncluded\": false\n    }\n  ]\n}\n```\n\n## Пример ответа при ошибке\n\n404 — лид не найден:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Элемент не найден\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 404 | `ENTITY_NOT_FOUND` | Лид не найден |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Установить товары](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-set)\n- [Получить лид](\u002Fdocs\u002Fentities\u002Fleads\u002Fget)\n- [Товары каталога](\u002Fdocs\u002Fentities\u002Fproducts)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization)\n","\n## Установить товары лида\n\n`PUT \u002Fv1\u002Fleads\u002F:id\u002Fproducts`\n\nУстанавливает товарные позиции лида. Полностью заменяет текущий список — передайте все нужные позиции.\n\n## Поля запроса (body)\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `items` | array | да | Массив товарных позиций |\n| `items[].productId` | number | да | ID товара. Каталог: `GET \u002Fv1\u002Fproducts` |\n| `items[].price` | number | да | Цена за единицу |\n| `items[].quantity` | number | да | Количество |\n| `items[].discount` | number | нет | Сумма скидки |\n| `items[].taxRate` | number | нет | Ставка налога (%) |\n| `items[].taxIncluded` | boolean | нет | Налог включён в цену |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X PUT \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F312\u002Fproducts\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"items\": [\n      { \"productId\": 1, \"price\": 25000, \"quantity\": 2 },\n      { \"productId\": 5, \"price\": 5000, \"quantity\": 1, \"discount\": 500 }\n    ]\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X PUT \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F312\u002Fproducts\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"items\": [\n      { \"productId\": 1, \"price\": 25000, \"quantity\": 2 },\n      { \"productId\": 5, \"price\": 5000, \"quantity\": 1, \"discount\": 500 }\n    ]\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F312\u002Fproducts', {\n  method: 'PUT',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    items: [\n      { productId: 1, price: 25000, quantity: 2 },\n      { productId: 5, price: 5000, quantity: 1, discount: 500 },\n    ],\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F312\u002Fproducts', {\n  method: 'PUT',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    items: [\n      { productId: 1, price: 25000, quantity: 2 },\n      { productId: 5, price: 5000, quantity: 1, discount: 500 },\n    ],\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `data` | array | Массив итоговых товарных позиций с полями productId, productName, price, quantity, discount, taxRate, taxIncluded |\n\nМассив итоговых товарных позиций с полями `productId`, `productName`, `price`, `quantity`, `discount`, `taxRate`, `taxIncluded`.\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"productId\": 1,\n      \"productName\": \"Серверное оборудование\",\n      \"price\": 25000,\n      \"quantity\": 2,\n      \"discount\": 0,\n      \"taxRate\": null,\n      \"taxIncluded\": false\n    },\n    {\n      \"productId\": 5,\n      \"productName\": \"Установка и настройка\",\n      \"price\": 5000,\n      \"quantity\": 1,\n      \"discount\": 500,\n      \"taxRate\": null,\n      \"taxIncluded\": false\n    }\n  ]\n}\n```\n\n## Пример ответа при ошибке\n\n400 — неверный формат:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INVALID_PARAMS\",\n    \"message\": \"items must be an array\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `INVALID_PARAMS` | `items` не является массивом |\n| 404 | `ENTITY_NOT_FOUND` | Лид не найден |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**Полная замена:** PUT заменяет весь список товаров. Чтобы добавить позицию — сначала получите текущие (`GET`), добавьте новую в массив, отправьте всё (`PUT`).\n\n## Смотрите также\n\n- [Товарные позиции](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-get)\n- [Получить лид](\u002Fdocs\u002Fentities\u002Fleads\u002Fget)\n- [Товары каталога](\u002Fdocs\u002Fentities\u002Fproducts)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization)\n","\n## Добавить товар в лид\n\n`POST \u002Fv1\u002Fleads\u002F:id\u002Fproducts`\n\nДобавляет одну товарную позицию в лид. В отличие от `PUT \u002Fv1\u002Fleads\u002F:id\u002Fproducts`, не заменяет существующие позиции.\n\n## Поля запроса (body)\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `id` (path) | number | да | ID лида |\n| `productId` | number | нет | ID товара из каталога. Если задан без `productName`, имя подставляется из каталога. Каталог: `GET \u002Fv1\u002Fproducts` |\n| `productName` | string | нет | Название товарной позиции — для произвольной строки без товара из каталога. Укажите хотя бы одно из `productId` \u002F `productName`. |\n| `price` | number | нет | Цена за единицу |\n| `quantity` | number | нет | Количество |\n| `discount` | number | нет | Сумма скидки |\n| `taxRate` | number | нет | Ставка налога (%) |\n| `taxIncluded` | boolean | нет | Налог включён в цену |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F312\u002Fproducts\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{ \"productId\": 1, \"price\": 25000, \"quantity\": 2 }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F312\u002Fproducts\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{ \"productId\": 1, \"price\": 25000, \"quantity\": 2 }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F312\u002Fproducts', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({ productId: 1, price: 25000, quantity: 2 }),\n})\n\nconst { success, data } = await res.json()\nconsole.log('ID строки:', data.id)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F312\u002Fproducts', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({ productId: 1, price: 25000, quantity: 2 }),\n})\n\nconst { success, data } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `data.id` | number | ID созданной товарной строки |\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 1465\n  }\n}\n```\n\n## Пример ответа при ошибке\n\n404 — лид не найден:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Элемент не найден\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 404 | `ENTITY_NOT_FOUND` | Лид не найден |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Товарные позиции](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-get)\n- [Установить товары](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-set)\n- [Удалить товар](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-delete)\n- [Товары каталога](\u002Fdocs\u002Fentities\u002Fproducts)\n","\n## Удалить товар из лида\n\n`DELETE \u002Fv1\u002Fleads\u002F:id\u002Fproducts\u002F:rowId`\n\nУдаляет одну товарную позицию из лида по ID строки. Восстановить удалённую позицию через API нельзя — добавляйте новую при необходимости.\n\n## Параметры\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `id` (path) | number | да | ID лида |\n| `rowId` (path) | number | да | ID товарной строки (из ответа add или list) |\n\n`rowId` — это ID товарной строки, а не `productId` из каталога товаров.\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X DELETE \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F312\u002Fproducts\u002F1465\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X DELETE \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F312\u002Fproducts\u002F1465\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F312\u002Fproducts\u002F1465', {\n  method: 'DELETE',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nif (res.status === 204) {\n  console.log('Товар удалён из лида')\n}\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F312\u002Fproducts\u002F1465', {\n  method: 'DELETE',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nif (res.status === 204) {\n  console.log('Удалено')\n}\n```\n\n## Ответ\n\nПри успешном удалении возвращается HTTP-статус `204 No Content` с пустым телом — признак успеха проверяется по статусу.\n\n## Пример ответа\n\n```\nHTTP\u002F1.1 204 No Content\n```\n\n## Пример ответа при ошибке\n\n404 — лид не найден:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Элемент не найден\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 404 | `ENTITY_NOT_FOUND` | Лид или товарная строка не найдена |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Товарные позиции](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-get)\n- [Добавить товар](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-add)\n- [Установить товары](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-set)\n- [Товары каталога](\u002Fdocs\u002Fentities\u002Fproducts)\n","\n## Получить товар из лида\n\n`GET \u002Fv1\u002Fleads\u002F:id\u002Fproducts\u002F:rowId`\n\nВозвращает одну товарную позицию лида по ID строки.\n\n## Параметры\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `id` (path) | number | да | ID лида |\n| `rowId` (path) | number | да | ID товарной строки (из ответа add или list) |\n\n`rowId` — это ID товарной строки, а не `productId` из каталога товаров.\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X GET \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F741\u002Fproducts\u002F1471\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X GET \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F741\u002Fproducts\u002F1471\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F741\u002Fproducts\u002F1471', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { success, data } = await res.json()\nconsole.log('Цена:', data.price)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F741\u002Fproducts\u002F1471', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { success, data } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `data.id` | number | ID товарной строки |\n| `data.productId` | number | ID товара из каталога |\n| `data.productName` | string | Название товара |\n| `data.price` | number | Цена за единицу |\n| `data.quantity` | number | Количество |\n| `data.discount` | number | Сумма скидки |\n| `data.discountRate` | number | Процент скидки |\n| `data.discountTypeId` | number | Тип скидки (1 — сумма, 2 — процент) |\n| `data.taxRate` | number \\| null | Ставка налога (%) |\n| `data.taxIncluded` | boolean | Налог включён в цену |\n| `data.priceExclusive` | number | Цена без скидки |\n| `data.priceNetto` | number | Цена нетто |\n| `data.priceBrutto` | number | Цена брутто |\n| `data.priceAccount` | number | Цена в валюте учёта |\n| `data.measureCode` | number | Код единицы измерения |\n| `data.measureName` | string | Название единицы измерения |\n| `data.sort` | number | Сортировка |\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 1471,\n    \"productId\": 1,\n    \"productName\": \"День добрый!\",\n    \"price\": 5000,\n    \"priceAccount\": 5000,\n    \"priceExclusive\": 5000,\n    \"priceNetto\": 5000,\n    \"priceBrutto\": 5000,\n    \"quantity\": 3,\n    \"discountTypeId\": 2,\n    \"discountRate\": 0,\n    \"discount\": 0,\n    \"taxRate\": null,\n    \"taxIncluded\": false,\n    \"customized\": \"Y\",\n    \"measureCode\": 796,\n    \"measureName\": \"шт\",\n    \"sort\": 0,\n    \"xmlId\": \"sale_basket_995\",\n    \"type\": 1\n  }\n}\n```\n\n## Пример ответа при ошибке\n\n404 — лид или товарная строка не найден:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Элемент не найден\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 404 | `ENTITY_NOT_FOUND` | Лид или товарная строка не найден |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Товарные позиции](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-get)\n- [Обновить товар](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-update)\n- [Добавить товар](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-add)\n- [Удалить товар](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-delete)\n- [Товары каталога](\u002Fdocs\u002Fentities\u002Fproducts)\n","\n## Обновить товар лида\n\n`PATCH \u002Fv1\u002Fleads\u002F:id\u002Fproducts\u002F:rowId`\n\nОбновляет товарную позицию лида. Передайте только изменяемые поля.\n\n## Параметры\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `id` (path) | number | да | ID лида |\n| `rowId` (path) | number | да | ID товарной позиции (из ответа list или add, не productId из каталога) |\n\n## Поля запроса (body)\n\n| Параметр | Тип | Описание |\n|----------|-----|---------|\n| `price` | number | Цена за единицу |\n| `quantity` | number | Количество |\n| `productId` | number | ID товара. Каталог: `GET \u002Fv1\u002Fproducts` |\n| `discount` | number | Сумма скидки |\n| `taxRate` | number | Ставка налога (%) |\n| `taxIncluded` | boolean | Налог включён в цену |\n| `sort` | number | Сортировка |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X PATCH \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F741\u002Fproducts\u002F1471\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{ \"price\": 9999, \"quantity\": 10 }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X PATCH \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F741\u002Fproducts\u002F1471\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{ \"price\": 9999, \"quantity\": 10 }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F741\u002Fproducts\u002F1471', {\n  method: 'PATCH',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({ price: 9999, quantity: 10 }),\n})\n\nconst { success, data } = await res.json()\nconsole.log('Обновлено:', data.price, 'x', data.quantity)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F741\u002Fproducts\u002F1471', {\n  method: 'PATCH',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({ price: 9999, quantity: 10 }),\n})\n\nconst { success, data } = await res.json()\n```\n\n## Поля ответа\n\nОбновлённый объект товарной позиции: `id`, `productId`, `productName`, `price`, `quantity`, `discount`, `taxRate`, `taxIncluded`.\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 1471,\n    \"productId\": 1,\n    \"productName\": \"Серверное оборудование\",\n    \"price\": 9999,\n    \"quantity\": 10,\n    \"discount\": 0,\n    \"taxRate\": null,\n    \"taxIncluded\": false\n  }\n}\n```\n\n## Пример ответа при ошибке\n\n404 — позиция не найдена:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Элемент не найден\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 404 | `ENTITY_NOT_FOUND` | Позиция не найдена |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Получить товар](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-get-single)\n- [Получить товары](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-get)\n- [Добавить товар](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-add)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization)\n","\n## Поля товаров лида\n\n`GET \u002Fv1\u002Fleads\u002F:id\u002Fproducts\u002Ffields`\n\nВозвращает описание полей товарных позиций лида: названия, типы, доступность для чтения и записи.\n\n## Параметры\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `id` (path) | number | да | ID лида |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F741\u002Fproducts\u002Ffields\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F741\u002Fproducts\u002Ffields\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F741\u002Fproducts\u002Ffields', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { success, data } = await res.json()\nconsole.log('Полей:', Object.keys(data).length)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fleads\u002F741\u002Fproducts\u002Ffields', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { success, data } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | RO | Обяз. | Описание |\n|------|-----|:--:|:-----:|---------|\n| `id` | integer | да | | ID позиции |\n| `productId` | integer | | да | ID товара. Каталог: `GET \u002Fv1\u002Fproducts` |\n| `productName` | string | | | Название товара |\n| `price` | double | | | Цена |\n| `quantity` | double | | | Количество |\n| `discountSum` | double | | | Сумма скидки |\n| `discountRate` | double | | | Величина скидки (%) |\n| `discountTypeId` | integer | | | Тип скидки |\n| `taxRate` | double | | | Налог (%) |\n| `taxIncluded` | char | | | Налог включён в цену (`Y`\u002F`N`) |\n| `priceExclusive` | double | да | | Цена без налога со скидкой |\n| `priceNetto` | double | да | | Цена нетто |\n| `priceBrutto` | double | да | | Цена брутто |\n| `measureCode` | integer | | | Код единицы измерения |\n| `measureName` | string | | | Единица измерения |\n| `customized` | char | | | Изменён (`Y`\u002F`N`) |\n| `sort` | integer | | | Сортировка |\n| `type` | integer | да | | Тип |\n| `storeId` | integer | да | | ID склада |\n| `ownerId` | integer | | да | ID владельца (лида) |\n| `ownerType` | string | | да | Тип владельца |\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": { \"type\": \"integer\", \"isRequired\": false, \"isReadOnly\": true, \"title\": \"ID\" },\n    \"ownerId\": { \"type\": \"integer\", \"isRequired\": true, \"isReadOnly\": false, \"isImmutable\": true, \"title\": \"ID владельца\" },\n    \"ownerType\": { \"type\": \"string\", \"isRequired\": true, \"isReadOnly\": false, \"isImmutable\": true, \"title\": \"Тип владельца\" },\n    \"productId\": { \"type\": \"integer\", \"isRequired\": true, \"isReadOnly\": false, \"title\": \"Товар\" },\n    \"productName\": { \"type\": \"string\", \"isRequired\": false, \"isReadOnly\": false, \"title\": \"Название товара\" },\n    \"price\": { \"type\": \"double\", \"isRequired\": false, \"isReadOnly\": false, \"title\": \"Цена\" },\n    \"priceExclusive\": { \"type\": \"double\", \"isRequired\": false, \"isReadOnly\": true, \"title\": \"Цена без налога со скидкой\" },\n    \"priceNetto\": { \"type\": \"double\", \"isRequired\": false, \"isReadOnly\": true, \"title\": \"PRICE_NETTO\" },\n    \"priceBrutto\": { \"type\": \"double\", \"isRequired\": false, \"isReadOnly\": true, \"title\": \"PRICE_BRUTTO\" },\n    \"quantity\": { \"type\": \"double\", \"isRequired\": false, \"isReadOnly\": false, \"title\": \"Количество\" },\n    \"discountTypeId\": { \"type\": \"integer\", \"isRequired\": false, \"isReadOnly\": false, \"title\": \"Тип скидки\" },\n    \"discountRate\": { \"type\": \"double\", \"isRequired\": false, \"isReadOnly\": false, \"title\": \"Величина скидки\" },\n    \"discountSum\": { \"type\": \"double\", \"isRequired\": false, \"isReadOnly\": false, \"title\": \"Сумма скидки\" },\n    \"taxRate\": { \"type\": \"double\", \"isRequired\": false, \"isReadOnly\": false, \"title\": \"Налог\" },\n    \"taxIncluded\": { \"type\": \"char\", \"isRequired\": false, \"isReadOnly\": false, \"title\": \"Налог включен в цену\" },\n    \"customized\": { \"type\": \"char\", \"isRequired\": false, \"isReadOnly\": false, \"title\": \"Изменен\" },\n    \"measureCode\": { \"type\": \"integer\", \"isRequired\": false, \"isReadOnly\": false, \"title\": \"Код единицы измерения\" },\n    \"measureName\": { \"type\": \"string\", \"isRequired\": false, \"isReadOnly\": false, \"title\": \"Единица измерения\" },\n    \"sort\": { \"type\": \"integer\", \"isRequired\": false, \"isReadOnly\": false, \"title\": \"Сортировка\" },\n    \"type\": { \"type\": \"integer\", \"isRequired\": false, \"isReadOnly\": true, \"title\": \"TYPE\" },\n    \"storeId\": { \"type\": \"integer\", \"isRequired\": false, \"isReadOnly\": true, \"title\": \"STORE_ID\" }\n  }\n}\n```\n\n## Пример ответа при ошибке\n\n404 — лид не найден:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Элемент не найден\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 404 | `ENTITY_NOT_FOUND` | Лид не найден |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Товарные позиции](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-get)\n- [Добавить товар](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-add)\n- [Установить товары](\u002Fdocs\u002Fentities\u002Fleads\u002Fproducts-set)\n- [Поля лида](\u002Fdocs\u002Fentities\u002Fleads\u002Ffields)\n"]