How to Add Data to CRM: Overview of Use Cases and Scenarios

This section helps you select a scenario for CRM integration. The materials describe creating objects and adding related data: files, company details, activities, documents, and SPA configurations.

You can use the tables to select a scenario based on the CRM object, the integration result, and the primary REST methods.

Select an Object TypeSelect an Object Type

Start by selecting a base object. The choice depends on the customer's interaction stage and the data source.

Lead. Suitable for initial inquiries: website applications, chat messages, or cold contacts. If the portal uses classic CRM mode and the inquiry has not yet been qualified, start with a lead.

Contact and Company. Use these objects when the customer has already been identified. A contact describes a person, while a company describes an organization. They are often created as a pair.

Deal. Required to launch a commercial process. A deal is usually created along with a company and company details if the purpose of the inquiry is a sale.

Scenarios by Primary ObjectsScenarios by Primary Objects

Scenario	Main methods	Result
Add lead via web form	crm.item.add with entityTypeId = 1	New lead ID
Add repeat lead	crm.duplicate.findbycomm, crm.lead.list, crm.lead.add	New repeat lead ID after the duplicate check
Add contact via web form	crm.item.add with entityTypeId = 3	New contact ID
Add company via web form	crm.item.add with entityTypeId = 4	New company ID
Add deal and company with billing details	crm.company.add, crm.requisite.add, crm.deal.add	Company, billing details, and deal ID

Work with Related DataWork with Related Data

Company details, addresses, files, and vendors are stored separately from the main CRM card. They are created independently and then linked to a lead, contact, company, or deal.

Company details and Addresses. Banking company details and legal addresses are stored separately from contacts and companies. First, retrieve the company details templates, then create the object itself and link an address to it.

Files. Files are attached via custom fields. Before creating an object, determine which field the file will be uploaded to.

Vendors. A vendor is a separate object type for procurement and warehouse documents. To add a vendor, use universal CRM and catalog methods.

Scenarios by Related DataScenarios by Related Data

Scenario	Main methods	Result
Add lead with files via web form	crm.lead.add, crm.lead.userfield.add	Lead ID with filled file fields
Add contact with billing details via web form	crm.contact.add, crm.requisite.add, crm.address.add	Contact, billing details, and address ID
Add company with billing details via web form	crm.company.add, crm.requisite.add, crm.address.add	Company, billing details, and address ID
How to create a vendor in CRM	crm.category.list, crm.item.add, catalog.documentcontractor.add	Vendor ID for warehouse documents

Add Activities and DocumentsAdd Activities and Documents

Record actions that should remain in the customer card: meetings, e-mails, tasks, and documents.

Activities. Calendar events, e-mails, and tasks are saved in the CRM as activities. When creating them, specify the owner type and the CRM object ID.

Accounting for CRM Mode. CRM mode determines where a new inquiry will go: to a lead or directly to a deal. If the integration must work across different portals, check the CRM mode before creating an activity.

Documents. Document generation occurs via templates. First, configure the numbering sequence and upload a template, then create a document linked to a CRM object.

Scenarios by Activities and DocumentsScenarios by Activities and Documents

Scenario	Main methods	Result
Add activity to a new lead or deal depending on CRM mode	crm.settings.mode.get, crm.deal.list, crm.activity.todo.add	Activity ID linked to a lead or deal
Add calendar event for client management	crm.contact.get, crm.activity.add	Activity ID of type "Event"
How to send an e-mail to a client on behalf of an employee	crm.contact.get, crm.activity.add	Activity ID of type "E-mail"
How to add a template and create a document based on it	crm.documentgenerator.numerator.add, crm.documentgenerator.template.add, crm.documentgenerator.document.add	Document ID and file link

Configure SPAsConfigure SPAs

If standard CRM objects are insufficient, use SPAs. These are custom CRM types with their own fields, pipelines, and stages.

Entity Type ID (entityTypeId). A key parameter for working with smart processes. Retrieve it before calling API methods, configuring fields, or adding comments.

Pipelines and Stages. Configure the process flow through stages. Create a pipeline and add the necessary statuses to it.

Custom Fields. Extend the SPA card with your own fields. Configure the field type, number format, list options, and display parameters.

Scenarios by Smart ProcessesScenarios by Smart Processes

Scenario	Main methods	Result
How to add a comment to the SPA timeline	crm.type.list, crm.item.list, crm.timeline.comment.add	Timeline entry ID
How to create a custom field in a smart process	crm.type.list, userfieldconfig.add	Custom field ID
How to configure rounding for a "Number" type custom field	crm.userfield.settings.fields, crm.deal.userfield.list, userfieldconfig.update	Updated number field settings
How to create a new pipeline with stages in a smart process	crm.type.list, crm.category.add, crm.status.add	Pipeline and created stages ID