Typical use-cases and scenarios for REST API in CRM and tutorials
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
The CRM reference describes individual methods, while tutorials show how to assemble a working scenario out of them: in which order to call the methods, which identifiers to pass between requests, and what to verify in the result.
Tutorials are grouped into five directions. Select a direction by your task, and inside it a tutorial for the specific case. An overview of the directions with a table of common scenarios is collected on the CRM: Common Scenarios page.
Quick links: All Scenarios
User documentation: How to Start Working with CRM in Bitrix24
Scenarios by Direction
Add Data
The scenarios create leads, contacts, companies, deals, activities, documents, and smart process items, and also link requisites, addresses, and product rows to them. Main method groups: crm.lead.*, crm.contact.*, crm.company.*, crm.deal.*, crm.item.*, activities, and requisites. An overview of the direction is available in How to Add Data to CRM: Overview of Use Cases and Scenarios.
|
If You Need To |
Open |
|
Accept a request from a website form and create a lead |
|
|
Create a lead for a customer who has already contacted you |
|
|
Create a contact from website form data |
|
|
Create a company from website form data |
|
|
Create a deal and a company with a choice of requisites |
|
|
Accept a request with attached files |
|
|
Create a contact together with requisites and an address |
|
|
Create a company together with requisites and an address |
|
|
Add a vendor for inventory documents |
|
|
Create an activity taking the CRM mode into account — simple or classic |
Add a CRM Activity to a New Lead or Deal Depending on the CRM Mode |
|
Schedule a meeting or a calendar event for a customer |
|
|
Send an email to a customer on behalf of an employee |
|
|
Build a document from a template — an invoice, a contract, or a statement |
|
|
Post a comment to the timeline of a smart process |
|
|
Add a custom field to a smart process |
|
|
Set the rounding of a numeric field |
|
|
Create a pipeline with stages in a smart process |
How to Create a New Sales Funnel with Stages in a Smart Process |
|
Add products with discounts and taxes to a CRM object |
How to Create a CRM Object with Products, Discounts, and Taxes |
Edit Data
The scenarios update card fields, phone numbers and emails, move activities between objects, and write the payment date into a deal field. Main method groups: crm.item.*, crm.lead.*, crm.contact.*, crm.company.*, crm.deal.*, and activities. An overview of the direction is available in Editing Data in CRM.
|
If You Need To |
Open |
|
Provide an employee with a web form for creating and editing a lead |
|
|
Provide a web form for creating and editing a contact |
|
|
Provide a web form for creating and editing a company |
|
|
Provide a web form for a deal with a choice of pipeline and stage |
|
|
Change or delete a customer phone number and email |
|
|
Shift the due date and reminders of a scheduled activity |
|
|
Move an activity to another item of the same type |
|
|
Move an activity to an object of a different type |
|
|
Copy the payment date into a deal field |
Retrieve Lists
The scenarios find duplicates, retrieve activities, stages, pipelines, addresses, and vendors, and filter items by stage. Main method groups: crm.duplicate.*, crm.status.*, crm.category.*, crm.item.*, and requisites. An overview of the direction is available in Retrieving Lists in CRM.
|
If You Need To |
Open |
|
Check whether the customer is already in CRM before creating a new one |
|
|
Retrieve a customer address from requisites |
|
|
Retrieve the stages of an object together with their semantics |
How to Retrieve a List of Stages with Semantics for CRM Entities |
|
Retrieve deal pipelines with their stages |
|
|
Select the items that are at a particular stage |
|
|
Retrieve activities linked to an employee’s deals |
|
|
Select contacts and companies marked as vendors |
Sales Intelligence
The scenarios pass the source of the inquiry and the customer journey into CRM through UTM fields, the TRACE field, or a separate trace. Main method groups: CRM tracking and the methods that create CRM objects. An overview of the direction is available in How to Use Sales Intelligence Data.
|
If You Need To |
Open |
|
Choose how to pass the data — UTM fields, |
|
|
Pass the source of the inquiry when creating a lead |
|
|
Link a contact and a deal to a single trace |
Widgets in CRM
The scenarios embed the application interface into a CRM card — through a custom field or a separate tab. Main method groups: widgets and custom field types. An overview of the direction is available in How to embed widgets in CRM.
|
If You Need To |
Open |
|
Show the application inside a field of a lead card |
|
|
Add your own tab to a CRM card |