Leads in CRM: Overview of Methods

A lead is the starting point of the Sales Funnel. Its card contains information about the client's interest in a product or service: filled CRM forms, e-mails, calls, and chats with the client.

The main goal of working with leads is to determine their potential and convert them into deals for further selling of the product or service.

Quick navigation: all methods and events

User documentation: leads in Bitrix24

Connection of Leads with Other CRM Objects

Products. Adding, modifying, and deleting product items in deals is possible through the group of methods crm.item.productrow.*.

Deal. The connection appears after converting the lead into a successful one.

Client. A field in the lead card consisting of the associated company and contacts. The field is available in the repeat lead form. If repeat leads are disabled, the linking field appears after creating a company or contact based on the lead. There is one company in the lead, and access to it is made directly through the field COMPANY_ID. Multiple contacts can be specified, and interaction with them is conducted through a separate group of methods crm.lead.contact.*.

User Documentation

Lead Card

The main workspace in a lead is the General tab of its card. It consists of two parts:

  • The left part contains fields with information. If the system fields are insufficient, you can create your own custom fields. They allow storing information in various data formats: string, number, link, address, and others. To create, modify, retrieve, or delete custom lead fields, the group of methods crm.lead.userfield.* is used.

  • The right part contains the deal timeline. In it, you can create, edit, filter, and delete CRM activities — the group of methods crm.activity.*, and timeline records — the group of methods crm.timeline.*.

The parameters of the deal card can be managed depending on the funnel through the group of methods crm.lead.details.configuration.*.

User Documentation

Widgets

An application can be embedded into the lead card. Thanks to embedding, you can use the application without leaving the lead card.

There are two embedding scenarios:

  • Use special embedding locations. For example, by creating your own tab.
  • Create a custom field, into which the content of your application will be loaded.

Typical Use-Cases and Scenarios

Features

Leads in CRM may be absent — this happens if the simple mode of CRM operation is activated.

It is impossible to convert a lead using the REST API. You can only change the stage to successful without creating new objects.

User Documentation

Overview of Methods and Events

Scope: crm

Who can execute the method: depending on the method

Main

Method

Description

crm.lead.add

Creates a new lead

crm.lead.update

Modifies a lead

crm.lead.get

Returns a lead by ID

crm.lead.list

Returns a list of leads by filter

crm.lead.delete

Deletes a lead and all associated objects

crm.lead.fields

Returns the description of lead fields

crm.lead.productrows.set

Adds products to a lead

crm.lead.productrows.get

Returns the products of a lead

Event

Triggered

onCrmLeadAdd

When a lead is added

onCrmLeadUpdate

When a lead is modified

onCrmLeadDelete

When a lead is deleted

Connection Between Leads and Contacts

Method

Description

crm.lead.contact.add

Adds a contact binding to the specified lead

crm.lead.contact.delete

Removes a contact binding from the specified lead

crm.lead.contact.items.get

Retrieves a list of contacts associated with the lead

crm.lead.contact.items.set

Attaches a list of contacts to the specified lead

crm.lead.contact.items.delete

Removes the list of contacts from the lead

crm.lead.contact.fields

Retrieves the description of fields for lead-contact connection, used by methods of the crm.lead.contact.* family

Custom Fields

Method

Description

crm.lead.userfield.add

Creates a new field

crm.lead.userfield.update

Modifies a field

crm.lead.userfield.get

Returns a field by code

crm.lead.userfield.list

Returns a list of fields

crm.lead.userfield.delete

Deletes a field

Event

Triggered

onCrmLeadUserFieldAdd

When a custom field is added

onCrmLeadUserFieldUpdate

When a custom field is modified

onCrmLeadUserFieldDelete

When a custom field is deleted

onCrmLeadUserFieldSetEnumValues

When the set of values for a custom list-type field is modified

Managing Lead Cards

Method

Description

crm.lead.details.configuration.get

Retrieves the settings parameters for lead cards

crm.lead.details.configuration.reset

Resets the settings for lead cards

crm.lead.details.configuration.set

Sets the settings for lead cards

crm.lead.details.configuration.forceCommonScopeForAll

Forces a common lead card for all users
Previous
Widgets
Next
Create a New Lead