Лиды в CRM: обзор методов
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Лид — начальная точка воронки продаж. В его карточке собрана информация о заинтересованности клиента в продукте или услуге: заполнения CRM-форм, электронные письма, звонки и чаты с клиентом.
Основная цель работы с лидами — определить, насколько они перспективны, и перевести их в сделки для дальнейшей продажи товара или услуги.
Быстрый переход: все методы и события
Пользовательская документация: лиды в Битрикс24
Актуальная версия API
Развитие методов crm.lead.* и crm.lead.details.configuration.* остановлено. Для новой разработки используйте универсальные методы crm.item.* и передавайте в них entityTypeId: 1 — это идентификатор типа объекта «Лид». Методы crm.lead.* продолжают работать, оставляйте их только в существующих интеграциях.
|
Метод с остановленным развитием |
Чем заменить |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
У групп методов crm.lead.contact.* и crm.lead.userfield.* замены нет, они актуальны.
Имена полей в двух группах методов различаются: crm.lead.* принимает и возвращает поля в формате UPPER_CASE, например STATUS_ID, а crm.item.* — в формате camelCase, например statusId.
Как начать работу
- Получите список полей лида методом crm.lead.fields. Он вернет системные и пользовательские поля с их типами и названиями.
- Создайте лид методом crm.lead.add. Обязательных полей у лида нет, но без заполненного
TITLEего будет трудно найти в списке. - Добавьте в лид товарные позиции методом crm.lead.productrows.set, если обращение клиента касается конкретных товаров.
- Свяжите лид с контактами методами crm.lead.contact.*, если клиент уже есть в базе.
- Ведите лид по стадиям методом crm.lead.update, меняя поле
STATUS_ID. Список стадий возвращает метод crm.status.list с фильтромfilter[ENTITY_ID]=STATUS. - Подпишитесь на события лида, чтобы получать уведомления об изменениях в реальном времени.
Связь лидов с другими объектами CRM
Товары. Товарные позиции лида задает метод crm.lead.productrows.set и возвращает crm.lead.productrows.get. Универсальная замена этих методов — группа crm.item.productrow.* с параметром ownerType: L.
Сделка. Связь появляется после конвертации лида в успешный.
Клиент. Поле в карточке лида, состоящее из связанных с ним компании и контактов. Поле доступно в форме повторного лида. Если повторные лиды отключены, связывающее поле появляется после создания компании или контакта на основании лида. Компания в лиде одна, обращение к ней происходит напрямую через поле COMPANY_ID. Контактов может быть указано несколько, взаимодействие с ними ведется через отдельную группу методов crm.lead.contact.*.
Пользовательская документация
Карточка лида
Основное рабочее пространство в лиде — это вкладка «Общее» его карточки. Она состоит из двух частей:
-
левая, в ней располагаются поля с информацией. Если системных полей недостаточно, вы можете создать собственные пользовательские поля. Они позволяют хранить информацию в различных форматах данных: строка, число, ссылка, адрес и другие. Для создания, изменения, получения или удаления пользовательских полей лидов используется группа методов crm.lead.userfield.*
-
правая, в ней располагается таймлайн лида. В нем можно создавать, редактировать, фильтровать, удалять дела CRM — группа методов crm.activity.*, и записи таймлайна — группа методов crm.timeline.*
Составом секций и полей карточки лида управляет группа методов crm.lead.details.configuration.*. Настройки задаются отдельно для карточки простого лида и карточки повторного лида.
Пользовательская документация
Виджеты
В карточку лида можно встроить приложение. Благодаря встраиванию можно будет использовать приложение и не покидать карточку лида.
Есть два сценария встройки:
- использовать специальные места встраивания. Например, через создание своей вкладки
- создать пользовательское поле, в которое будет загружаться контент вашего приложения
Частые кейсы и сценарии
Особенности
Лид может не сохраниться как лид. В Битрикс24 есть два режима работы CRM. В классическом режиме лид остается в системе после создания. В простом режиме лидов нет: созданный лид система сразу конвертирует в сделку, и получить его методом crm.lead.get уже не выйдет. Проверяйте режим методом crm.settings.mode.get до того, как строить сценарий на лидах.
Конвертация недоступна в REST. Отдельного метода конвертации лида в контакт, компанию или сделку нет. Через API можно только перевести лид на успешную стадию методом crm.lead.update — новые объекты при этом не создаются, их придется создавать отдельными вызовами crm.contact.add, crm.company.add и crm.deal.add.
Повторный лид определяется системой. Признак повторного лида IS_RETURN_CUSTOMER доступен только на чтение: он выставляется в Y автоматически, когда у лида заполнено поле CONTACT_ID или COMPANY_ID. Напрямую передать IS_RETURN_CUSTOMER в crm.lead.add или crm.lead.update нельзя — значение будет пересчитано.
Пользовательская документация
Обзор методов и событий
Scope:
crmКто может выполнять метод: в зависимости от метода
Основные
|
Метод |
Описание |
|
Создает новый лид |
|
|
Изменяет лид |
|
|
Возвращает лид по идентификатору |
|
|
Возвращает список лидов по фильтру |
|
|
Удаляет лид и все связанные с ним объекты |
|
|
Устанавливает список товаров лида |
|
|
Возвращает товары лида |
|
|
Возвращает описание полей лида |
|
Событие |
Вызывается |
|
При добавлении лида вручную или методом crm.lead.add |
|
|
При изменении лида вручную или методом crm.lead.update |
|
|
При удалении лида вручную или методом crm.lead.delete |
Связь между лидами и контактами
|
Метод |
Описание |
|
Добавляет привязку контакта к указанному лиду |
|
|
Удаляет привязку контакта к указанному лиду |
|
|
Получает список связанных с лидом контактов |
|
|
Прикрепляет список контактов к указанному лиду |
|
|
Удаляет список контактов у лида |
|
|
Получает описание полей для связи лид-контакт, используемых методами семейства |
Пользовательские поля
|
Метод |
Описание |
|
Создает новое поле |
|
|
Изменяет поле |
|
|
Возвращает поле по коду |
|
|
Возвращает список полей |
|
|
Удаляет поле |
|
Событие |
Вызывается |
|
При добавлении пользовательского поля вручную или методом crm.lead.userfield.add |
|
|
При изменении пользовательского поля вручную или методом crm.lead.userfield.update |
|
|
При удалении пользовательского поля вручную или методом crm.lead.userfield.delete |
|
|
При изменении набора значений для пользовательского поля списочного типа вручную или методом crm.lead.userfield.update |
Управление карточками лидов
|
Метод |
Описание |
|
Устанавливает настройки карточки лидов |
|
|
Получает параметры настройки карточки лидов |
|
|
Сбрасывает настройки карточки лидов |
|
|
Принудительно устанавливает общую карточку лидов для всех пользователей |