CRM: Common Scenarios

CRM Integration begins with an application task: creating a customer or a deal, updating a card, retrieving lists, passing Sales Intelligence, or embedding an application interface.

Tutorials help you select a working scenario so you do not have to assemble a chain of methods manually. Each scenario specifies access permissions, the request order, identifiers to be passed between methods, a code sample, and the result to be verified.

Quick links: How to Choose a Direction and Common Scenarios

User documentation: CRM overview

Connection with CRM ObjectsConnection with CRM Objects

Scenarios work with core CRM objects and related data.

Leads, contacts, companies, and deals. Core customer and sales cards can be created, updated, and retrieved using the crm.lead.*, crm.contact.*, crm.company.*, and crm.deal.* methods.

Activities and Timeline. Calls, emails, meetings, tasks, and comments are linked to CRM cards via activity and timeline comment methods.

Company details, addresses, and line items. Related data is stored separately from the CRM card. These are created and linked to a customer, deal, or document using company details, addresses, line items, and catalog methods.

SPAs. Custom CRM types operate via entityTypeId — an object type identifier. To create items, pipelines, stages, and custom fields, use the universal crm.item.* methods.

Sales Intelligence. The source of inquiry and the customer route are passed to the CRM via UTM parameters, the TRACE field, or the crm.tracking.trace.add method.

CRM Widgets. An application interface can be embedded into a CRM card via a custom field or a tab. To register handlers, use the widgets methods and embedding points.

Getting StartedGetting Started

1. Define the integration task: create an object, modify data, retrieve a list, pass analytics, or embed an interface.
2. Select a direction in the How to Choose a Direction table.
3. Open the overview for the selected direction and find a scenario for your task.
4. Verify the access permissions and scopes specified in the scenario.
5. Prepare the CRM object, field, stage, or user identifiers required for the requests.
6. Execute the methods in the order described in the scenario.

How to Choose a DirectionHow to Choose a Direction

If needed	Open	What you will find
Create a lead, contact, company, deal, activity, document, or SPA item	Add data	19 scenarios for creating CRM objects and related data. Main methods and groups: crm.lead.add, crm.contact.add, crm.company.add, crm.deal.add, crm.item.add, crm.activity.*, crm.requisite.*
Change card fields, phones, email, activity date, activity link, or payment date	Edit data	10 scenarios for updating CRM data. Main methods and groups: crm.lead.update, crm.contact.update, crm.company.update, crm.deal.update, crm.activity.binding.*, crm.item.payment.list, crm.deal.userfield.*
Find duplicates, get activities, stages, pipelines, addresses, suppliers, or items by filter	Get lists	7 scenarios for retrieving data from CRM. Main methods and groups: crm.duplicate.findbycomm, crm.*.list, crm.activity.list, crm.status.*, crm.category.*, crm.item.list, crm.requisite.*
Pass UTM tags, TRACE, or link created objects to a trace	Sales Intelligence	3 scenarios for passing analytics data. Main methods: crm.lead.add, crm.contact.add, crm.company.add, crm.deal.add, crm.item.add, crm.tracking.trace.add
Add the application interface to a CRM card	How to embed widgets into CRM	2 scenarios for a lead custom field and a CRM card tab. Main methods and embedding points: userfieldtype.add, placement.bind, CRM

Common ScenariosCommon Scenarios

The table below is a selection of tasks used to begin working with the CRM. For a full list of materials, see the direction overviews: add data, edit data, retrieve lists, Sales Intelligence, and CRM widgets.

If needed	Open
Add a lead from a website form	How to add a lead
Add a lead with files	How to add a lead with files
Add a contact or company with billing details	How to add a contact with billing details or how to add a company with billing details
Add a deal and select the company's Company details	How to add a deal and a company with billing details
Create an activity in a lead or deal, taking the CRM mode into account	How to add an activity to a new lead or deal depending on the CRM mode
Change the scheduled activity date	How to change the time of a scheduled activity
Change client phone or email	How to change or delete phone numbers and email
Move activity between CRM cards	How to move activity between items of the same type or how to move activity from one object type to another
Find duplicates by phone or email	How to find duplicates in CRM by phone and email
Get stages, pipelines, or items by stage	How to get a list of stages with semantics, how to get deal pipelines, or how to filter items by stage name
Pass Sales Intelligence data when creating a lead or a deal	How to use Sales Intelligence when creating a lead or how to use Sales Intelligence when creating a deal and a contact
Embed the application interface into a CRM card	How to embed a widget into a lead as a custom field or how to embed a widget into a CRM card tab