метод REST scope: crm Устаревший

crm.lead.add

Создать новый лид

Устаревший метод. Развитие метода остановлено. Используйте crm.item.add.

Кто может выполнять: любой пользователь с правом на создание лидов

Описание

Метод crm.lead.add создает новый лид.

Параметры

fields object необязательный

Объект формата:

{
    field_1: value_1,
    field_2: value_2,
    ...,
    field_n: value_n,
}

где:
- field_n — название поля
- value_n — значение поля

Список доступных полей описан ниже

params object необязательный

Необязательный массив опций ("optionName"=>"value"[, ...]). Перечень возможных полей описан ниже

Параметр fields

ADDRESS string необязательный

Адрес

ADDRESS_2 string необязательный

Вторая страница адреса. В некоторых странах принято разбивать адрес на 2 части

ADDRESS_CITY string необязательный

Город

ADDRESS_COUNTRY string необязательный

Страна

ADDRESS_COUNTRY_CODE string необязательный

Код страны

ADDRESS_POSTAL_CODE string необязательный

Почтовый индекс

ADDRESS_PROVINCE string необязательный

Область

ADDRESS_REGION string необязательный

Район

ASSIGNED_BY_ID user необязательный

Ответственный

BIRTHDATE date необязательный

Дата рождения

COMMENTS string необязательный

Комментарии

COMPANY_ID crm_company необязательный

Привязка лида к компании

COMPANY_TITLE string необязательный

Название компании, указанное в соответствующем поле лида. Для привязки существующей компании стоит передавать её id в поле COMPANY_ID

CONTACT_ID crm_contact необязательный

Привязка лида к контакту

CONTACT_IDS crm_contact необязательный

Список привязанных к лиду контактов.

Контакты можно добавлять или удалять группой методов crm.lead.contact.*

CURRENCY_ID crm_currency необязательный

Идентификатор валюты

EMAIL crm_multifield необязательный

Адрес электронной почты. Множественное

HONORIFIC crm_status необязательный

Вид обращения

IM crm_multifield необязательный

Мессенджер. Множественное

LINK crm_multifield необязательный

ID пользователя, привязанного через открытую линию. Множественное

LAST_NAME string необязательный

Фамилия

NAME string необязательный

Имя

SECOND_NAME string необязательный

Отчество

OPENED char необязательный

Признак доступности лида для всех. Допустимые значения Y или N.

OPPORTUNITY double необязательный

Сумма

IS_MANUAL_OPPORTUNITY char необязательный

Признак ручного режима расчёта суммы. Допустимые значения Y или N

ORIGINATOR_ID string необязательный

Идентификатор источника данных.

Используется только для привязки к внешнему источнику

ORIGIN_ID string необязательный

Идентификатор элемента в источнике данных. Используется только для привязки к внешнему источнику

PHONE crm_multifield необязательный

Телефон. Множественное

POST string необязательный

Должность

SOURCE_DESCRIPTION string необязательный

Описание источника

SOURCE_ID crm_status необязательный

Идентификатор источника.
Значения по умолчанию:

#

Параметр params

REGISTER_SONET_EVENT boolean необязательный

Флаг Y/N - произвести регистрацию события добавления лида. Дополнительно будет отправлено уведомление ответственному за лид

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

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

Ответ

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 integer

Корневой элемент ответа, содержит идентификатор созданного лида

time time

Информация о времени выполнения запроса

Обработка ошибок

{
    "error": "",
    "error_description": "Access denied."
}

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.