Создать новый лид crm.lead.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: любой пользователь с правом на создание лидов
DEPRECATED
Развитие метода остановлено. Используйте crm.item.add.
Метод crm.lead.add создает новый лид.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields |
Объект формата:
где:
Список доступных полей описан ниже |
|
params |
Необязательный массив опций ( |
Параметр fields
|
Название |
Описание |
||||||||||||||||||||||||||
|
ADDRESS |
Адрес |
||||||||||||||||||||||||||
|
ADDRESS_2 |
Вторая страница адреса. В некоторых странах принято разбивать адрес на 2 части |
||||||||||||||||||||||||||
|
ADDRESS_CITY |
Город |
||||||||||||||||||||||||||
|
ADDRESS_COUNTRY |
Страна |
||||||||||||||||||||||||||
|
ADDRESS_COUNTRY_CODE |
Код страны |
||||||||||||||||||||||||||
|
ADDRESS_POSTAL_CODE |
Почтовый индекс |
||||||||||||||||||||||||||
|
ADDRESS_PROVINCE |
Область |
||||||||||||||||||||||||||
|
ADDRESS_REGION |
Район |
||||||||||||||||||||||||||
|
ASSIGNED_BY_ID |
Ответственный |
||||||||||||||||||||||||||
|
BIRTHDATE |
Дата рождения |
||||||||||||||||||||||||||
|
COMMENTS |
Комментарии |
||||||||||||||||||||||||||
|
COMPANY_ID |
Привязка лида к компании |
||||||||||||||||||||||||||
|
COMPANY_TITLE |
Название компании, указанное в соответствующем поле лида. Для привязки существующей компании стоит передавать её id в поле COMPANY_ID |
||||||||||||||||||||||||||
|
CONTACT_ID |
Привязка лида к контакту |
||||||||||||||||||||||||||
|
CONTACT_IDS |
Список привязанных к лиду контактов. Контакты можно добавлять или удалять группой методов crm.lead.contact.* |
||||||||||||||||||||||||||
|
CURRENCY_ID |
Идентификатор валюты |
||||||||||||||||||||||||||
|
EMAIL |
Адрес электронной почты. Множественное |
||||||||||||||||||||||||||
|
HONORIFIC |
Вид обращения |
||||||||||||||||||||||||||
|
Мессенджер. Множественное |
|||||||||||||||||||||||||||
|
LINK |
ID пользователя, привязанного через открытую линию. Множественное |
||||||||||||||||||||||||||
|
LAST_NAME |
Фамилия |
||||||||||||||||||||||||||
|
NAME |
Имя |
||||||||||||||||||||||||||
|
SECOND_NAME |
Отчество |
||||||||||||||||||||||||||
|
OPENED |
Признак доступности лида для всех. Допустимые значения |
||||||||||||||||||||||||||
|
OPPORTUNITY |
Сумма |
||||||||||||||||||||||||||
|
IS_MANUAL_OPPORTUNITY |
Признак ручного режима расчёта суммы. Допустимые значения Y или N |
||||||||||||||||||||||||||
|
ORIGINATOR_ID |
Идентификатор источника данных. Используется только для привязки к внешнему источнику |
||||||||||||||||||||||||||
|
ORIGIN_ID |
Идентификатор элемента в источнике данных. Используется только для привязки к внешнему источнику |
||||||||||||||||||||||||||
|
PHONE |
Телефон. Множественное |
||||||||||||||||||||||||||
|
POST |
Должность |
||||||||||||||||||||||||||
|
SOURCE_DESCRIPTION |
Описание источника |
||||||||||||||||||||||||||
|
SOURCE_ID |
Идентификатор источника.
Список всех возможных идентификаторов из справочника можно получить методом crm.status.list с фильтром |
||||||||||||||||||||||||||
|
STATUS_DESCRIPTION |
Дополнительно о стадии |
||||||||||||||||||||||||||
|
STATUS_ID |
Идентификатор стадии лида. Стадии по умолчанию:
Список всех возможных стадий из справочника можно получить методом crm.status.list с фильтром |
||||||||||||||||||||||||||
|
TITLE |
Название лида |
||||||||||||||||||||||||||
|
UTM_CAMPAIGN |
Обозначение рекламной кампании |
||||||||||||||||||||||||||
|
UTM_CONTENT |
Содержание кампании. Например, для контекстных объявлений |
||||||||||||||||||||||||||
|
UTM_MEDIUM |
Тип трафика. CPC (объявления), CPM (баннеры) |
||||||||||||||||||||||||||
|
UTM_SOURCE |
Рекламная система. Yandex-Direct, Google-Adwords и другие |
||||||||||||||||||||||||||
|
UTM_TERM |
Условие поиска кампании. Например, ключевые слова контекстной рекламы |
||||||||||||||||||||||||||
|
WEB |
Сайт. Множественное |
||||||||||||||||||||||||||
|
UF_... |
Пользовательские поля. Например, В зависимости от настроек портала у лидов может быть набор пользовательских полей определенных типов. Для создания, изменения или удаления пользовательских полей в лидах используйте методы crm.lead.userfield.* |
Примечание
Так же, чтобы узнать требуемый формат полей, можно выполнить метод crm.lead.fields и посмотреть формат пришедших значений этих полей.
Примечание
При добавлении лида нельзя явно установить признак повторного лида (поле IS_RETURN_CUSTOMER), однако, это поле автоматически принимает значение Y, если при добавлении лида указать значение для COMPANY_ID или CONTACT_ID
Параметр params
|
Название |
Описание |
|
REGISTER_SONET_EVENT |
Флаг |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TITLE":"ИП Титов","NAME":"Глеб","SECOND_NAME":"Егорович","LAST_NAME":"Титов","STATUS_ID":"NEW","OPENED":"Y","ASSIGNED_BY_ID":1,"CURRENCY_ID":"USD","OPPORTUNITY":12500,"PHONE":[{"VALUE":"555888","VALUE_TYPE":"WORK"}],"WEB":[{"VALUE":"www.mysite.com","VALUE_TYPE":"WORK"}]},"params":{"REGISTER_SONET_EVENT":"Y"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TITLE":"ИП Титов","NAME":"Глеб","SECOND_NAME":"Егорович","LAST_NAME":"Титов","STATUS_ID":"NEW","OPENED":"Y","ASSIGNED_BY_ID":1,"CURRENCY_ID":"USD","OPPORTUNITY":12500,"PHONE":[{"VALUE":"555888","VALUE_TYPE":"WORK"}],"WEB":[{"VALUE":"www.mysite.com","VALUE_TYPE":"WORK"}]},"params":{"REGISTER_SONET_EVENT":"Y"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.lead.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<number>({
method: 'crm.lead.add',
params: {
fields: {
TITLE: 'Sole proprietor Titov',
NAME: 'Gleb',
SECOND_NAME: 'Egorovich',
LAST_NAME: 'Titov',
STATUS_ID: 'NEW',
OPENED: 'Y',
ASSIGNED_BY_ID: 1,
CURRENCY_ID: 'USD',
OPPORTUNITY: 12500,
PHONE: [
{
VALUE: '555888',
VALUE_TYPE: 'WORK',
},
],
WEB: [
{
VALUE: 'www.mysite.com',
VALUE_TYPE: 'WORK',
},
],
},
params: {
REGISTER_SONET_EVENT: 'Y',
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Created lead id:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addLead() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.lead.add',
params: {
fields: {
TITLE: 'Sole proprietor Titov',
NAME: 'Gleb',
SECOND_NAME: 'Egorovich',
LAST_NAME: 'Titov',
STATUS_ID: 'NEW',
OPENED: 'Y',
ASSIGNED_BY_ID: 1,
CURRENCY_ID: 'USD',
OPPORTUNITY: 12500,
PHONE: [
{
VALUE: '555888',
VALUE_TYPE: 'WORK',
},
],
WEB: [
{
VALUE: 'www.mysite.com',
VALUE_TYPE: 'WORK',
},
],
},
params: {
REGISTER_SONET_EVENT: 'Y',
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Created lead id:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addLead)
</script>
try {
$response = $b24Service
->core
->call(
'crm.lead.add',
[
'fields' => [
'TITLE' => 'ИП Титов',
'NAME' => 'Глеб',
'SECOND_NAME' => 'Егорович',
'LAST_NAME' => 'Титов',
'STATUS_ID' => 'NEW',
'OPENED' => 'Y',
'ASSIGNED_BY_ID' => 1,
'CURRENCY_ID' => 'USD',
'OPPORTUNITY' => 12500,
'PHONE' => [
[
'VALUE' => '555888',
'VALUE_TYPE' => 'WORK',
],
],
'WEB' => [
[
'VALUE' => 'www.mysite.com',
'VALUE_TYPE' => 'WORK',
],
],
],
'params' => [
'REGISTER_SONET_EVENT' => 'Y',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Создан лид с ID ' . $result;
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Ошибка при создании лида: ' . $e->getMessage();
}
BX24.callMethod(
"crm.lead.add",
{
fields:
{
TITLE: "ИП Титов",
NAME: "Глеб",
SECOND_NAME: "Егорович",
LAST_NAME: "Титов",
STATUS_ID: "NEW",
OPENED: "Y",
ASSIGNED_BY_ID: 1,
CURRENCY_ID: "USD",
OPPORTUNITY: 12500,
PHONE: [
{
VALUE: "555888",
VALUE_TYPE: "WORK",
},
] ,
WEB: [
{
VALUE: "www.mysite.com",
VALUE_TYPE: "WORK",
}
],
},
params: {
REGISTER_SONET_EVENT: "Y",
}
},
(result) => {
if (result.error())
{
console.error(result.error());
return;
}
console.info(`Создан лид с ID ${result.data()}`);
}
);
require_once('crest.php');
$result = CRest::call(
'crm.lead.add',
[
'fields' => [
'TITLE' => 'ИП Титов',
'NAME' => 'Глеб',
'SECOND_NAME' => 'Егорович',
'LAST_NAME' => 'Титов',
'STATUS_ID' => 'NEW',
'OPENED' => 'Y',
'ASSIGNED_BY_ID' => 1,
'CURRENCY_ID' => 'USD',
'OPPORTUNITY' => 12500,
'PHONE' => [
[
'VALUE' => '555888',
'VALUE_TYPE' => 'WORK',
],
],
'WEB' => [
[
'VALUE' => 'www.mysite.com',
'VALUE_TYPE' => 'WORK',
],
],
],
'params' => [
'REGISTER_SONET_EVENT' => 'Y',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Пример
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
from datetime import datetime
client: BaseClient
lead_birthdate = datetime(1989, 7, 14).date().isoformat()
try:
bitrix_response = client.crm.lead.add(
fields={
"TITLE": "Acme Industrial Subscription",
"NAME": "Jordan",
"SECOND_NAME": "Avery",
"LAST_NAME": "Miller",
"STATUS_ID": "NEW",
"OPENED": "Y",
"ASSIGNED_BY_ID": 1,
"CURRENCY_ID": "USD",
"OPPORTUNITY": 25000.0,
"IS_MANUAL_OPPORTUNITY": "Y",
"SOURCE_ID": "WEB",
"SOURCE_DESCRIPTION": "Inbound product comparison form",
"COMMENTS": "Requested enterprise onboarding call next week.",
"COMPANY_TITLE": "Acme Industrial LLC",
"POST": "Procurement Director",
"BIRTHDATE": lead_birthdate,
"PHONE": [{"VALUE": "+12025550119", "VALUE_TYPE": "WORK"}],
"EMAIL": [{"VALUE": "jordan.miller@acme-industrial.com", "VALUE_TYPE": "WORK"}],
"WEB": [{"VALUE": "https://acme-industrial.com", "VALUE_TYPE": "WORK"}],
"UTM_SOURCE": "google-ads",
"UTM_MEDIUM": "cpc",
"UTM_CAMPAIGN": "q1_enterprise_leads",
"UTM_CONTENT": "landing_form_variant_a",
"UTM_TERM": "industrial crm integration",
},
params={"REGISTER_SONET_EVENT": "Y"},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
Обработка ответа
HTTP-статус: 200
{
"result": 3465,
"time": {
"start": 1705764932.998683,
"finish": 1705764937.173995,
"duration": 4.1753120422363281,
"processing": 3.3076529502868652,
"date_start": "2024-01-20T18:35:32+03:00",
"date_finish": "2024-01-20T18:35:37+03:00",
"operating_reset_at": 1705765533,
"operating": 3.3076241016387939
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа, содержит идентификатор созданного лида |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 40x, 50x Error
{
"error": "",
"error_description": "Access denied."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные ошибки
|
Код |
Текст ошибки |
Описание |
|
Пустое значение |
Access denied. |
У пользователя нет прав на добавление лида |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |