#Создать лид
POST /v1/leads
Создаёт новый лид в CRM.
#Поля запроса (body)
| Параметр | Тип | Описание |
|---|---|---|
title |
string | Название лида |
name |
string | Имя контакта |
lastName |
string | Фамилия контакта |
secondName |
string | Отчество |
statusId |
string | Статус лида. Стандартные: NEW, IN_PROCESS, PROCESSED. Портал может иметь свои — список: GET /v1/statuses?filter[entityId]=STATUS |
amount |
number | Сумма |
currency |
string | Валюта. Список: GET /v1/currencies |
companyTitle |
string | Название компании (текст, не ID) |
phone |
string/array | Телефон: [{ "value": "+7...", "typeId": "WORK" }] |
email |
string/array | Email: [{ "value": "a@b.com", "typeId": "WORK" }] |
post |
string | Должность |
comments |
string | Комментарий |
sourceId |
string | Источник. Список: GET /v1/statuses?filter[entityId]=SOURCE |
sourceDescription |
string | Описание источника |
assignedById |
number | Ответственный. Список: GET /v1/users |
opened |
boolean | Доступен для всех |
Полный список полей: GET /v1/leads/fields.
#Примеры
#curl — личный ключ
curl -X POST https://vibecode.bitrix24.tech/v1/leads \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Заявка с сайта",
"name": "Мария",
"lastName": "Сидорова",
"phone": [{ "value": "+79161234567", "typeId": "WORK" }],
"sourceId": "WEB",
"statusId": "NEW"
}'
#curl — OAuth-приложение
curl -X POST https://vibecode.bitrix24.tech/v1/leads \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"title": "Заявка с сайта",
"name": "Мария",
"lastName": "Сидорова",
"phone": [{ "value": "+79161234567", "typeId": "WORK" }],
"sourceId": "WEB",
"statusId": "NEW"
}'
#JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/leads', {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
title: 'Заявка с сайта',
name: 'Мария',
lastName: 'Сидорова',
phone: [{ value: '+79161234567', typeId: 'WORK' }],
sourceId: 'WEB',
statusId: 'NEW',
}),
})
const { success, data } = await res.json()
console.log('Lead ID:', data.id)
#JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/leads', {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({
title: 'Заявка с сайта',
name: 'Мария',
lastName: 'Сидорова',
phone: [{ value: '+79161234567', typeId: 'WORK' }],
sourceId: 'WEB',
statusId: 'NEW',
}),
})
const { success, data } = await res.json()
#Поля ответа
| Поле | Тип | Описание |
|---|---|---|
id |
number | ID созданного лида |
title |
string | Название |
statusId |
string | Статус |
assignedById |
number | Ответственный |
createdBy |
number | Создатель |
createdTime |
datetime | Дата создания |
Ответ содержит все поля лида.
#Пример ответа
{
"success": true,
"data": {
"id": 5001,
"title": "Заявка с сайта",
"statusId": "NEW",
"assignedById": 1,
"createdBy": 1,
"createdTime": "2026-04-15T13:00:00+03:00",
"updatedTime": "2026-04-15T13:00:00+03:00",
"opened": true,
"sourceId": "WEB"
}
}
#Пример ответа при ошибке
403 — нет скоупа:
{
"success": false,
"error": {
"code": "SCOPE_DENIED",
"message": "This endpoint requires 'crm' scope"
}
}
#Ошибки
| HTTP | Код | Описание |
|---|---|---|
| 403 | SCOPE_DENIED |
API-ключ не имеет скоупа crm |
| 401 | TOKEN_MISSING |
API-ключ не имеет настроенных токенов |
| 400 | INVALID_REQUEST |
Невалидные поля |
Полный список общих ошибок API — Ошибки.
#Известные особенности
Конвертация лида: B24 REST не имеет отдельного метода конвертации. Чтобы «конвертировать» лид, создайте сделку/контакт/компанию с leadId и обновите статус лида:
// 1. Создать сделку из лида
await fetch('/v1/deals', { body: { title: 'Из лида', leadId: 5001 } })
// 2. Закрыть лид
await fetch('/v1/leads/5001', { method: 'PATCH', body: { statusId: 'CONVERTED' } })
#Смотрите также
- Список лидов — получение с фильтрами
- Поля лида — полный список полей
- Сделки — создание сделки из лида через
leadId - Entity API — общие принципы
- Лимиты и оптимизация — rate limits