Лиды в 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.add

crm.item.add

crm.lead.update

crm.item.update

crm.lead.get

crm.item.get

crm.lead.list

crm.item.list

crm.lead.delete

crm.item.delete

crm.lead.fields

crm.item.fields

crm.lead.productrows.*

crm.item.productrow.*

crm.lead.details.configuration.*

crm.item.details.configuration.*

У групп методов crm.lead.contact.* и crm.lead.userfield.* замены нет, они актуальны.

Имена полей в двух группах методов различаются: crm.lead.* принимает и возвращает поля в формате UPPER_CASE, например STATUS_ID, а crm.item.* — в формате camelCase, например statusId.

Как начать работу

  1. Получите список полей лида методом crm.lead.fields. Он вернет системные и пользовательские поля с их типами и названиями.
  2. Создайте лид методом crm.lead.add. Обязательных полей у лида нет, но без заполненного TITLE его будет трудно найти в списке.
  3. Добавьте в лид товарные позиции методом crm.lead.productrows.set, если обращение клиента касается конкретных товаров.
  4. Свяжите лид с контактами методами crm.lead.contact.*, если клиент уже есть в базе.
  5. Ведите лид по стадиям методом crm.lead.update, меняя поле STATUS_ID. Список стадий возвращает метод crm.status.list с фильтром filter[ENTITY_ID]=STATUS.
  6. Подпишитесь на события лида, чтобы получать уведомления об изменениях в реальном времени.

Связь лидов с другими объектами 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.get

Возвращает лид по идентификатору

crm.lead.list

Возвращает список лидов по фильтру

crm.lead.delete

Удаляет лид и все связанные с ним объекты

crm.lead.productrows.set

Устанавливает список товаров лида

crm.lead.productrows.get

Возвращает товары лида

crm.lead.fields

Возвращает описание полей лида

Событие

Вызывается

onCrmLeadAdd

При добавлении лида вручную или методом crm.lead.add

onCrmLeadUpdate

При изменении лида вручную или методом crm.lead.update

onCrmLeadDelete

При удалении лида вручную или методом crm.lead.delete

Связь между лидами и контактами

Метод

Описание

crm.lead.contact.add

Добавляет привязку контакта к указанному лиду

crm.lead.contact.delete

Удаляет привязку контакта к указанному лиду

crm.lead.contact.items.get

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

crm.lead.contact.items.set

Прикрепляет список контактов к указанному лиду

crm.lead.contact.items.delete

Удаляет список контактов у лида

crm.lead.contact.fields

Получает описание полей для связи лид-контакт, используемых методами семейства crm.lead.contact.*

Пользовательские поля

Метод

Описание

crm.lead.userfield.add

Создает новое поле

crm.lead.userfield.update

Изменяет поле

crm.lead.userfield.get

Возвращает поле по коду

crm.lead.userfield.list

Возвращает список полей

crm.lead.userfield.delete

Удаляет поле

Событие

Вызывается

onCrmLeadUserFieldAdd

При добавлении пользовательского поля вручную или методом crm.lead.userfield.add

onCrmLeadUserFieldUpdate

При изменении пользовательского поля вручную или методом crm.lead.userfield.update

onCrmLeadUserFieldDelete

При удалении пользовательского поля вручную или методом crm.lead.userfield.delete

onCrmLeadUserFieldSetEnumValues

При изменении набора значений для пользовательского поля списочного типа вручную или методом crm.lead.userfield.update

Управление карточками лидов

Метод

Описание

crm.lead.details.configuration.set

Устанавливает настройки карточки лидов

crm.lead.details.configuration.get

Получает параметры настройки карточки лидов

crm.lead.details.configuration.reset

Сбрасывает настройки карточки лидов

crm.lead.details.configuration.forceCommonScopeForAll

Принудительно устанавливает общую карточку лидов для всех пользователей