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

This section helps you choose a scenario for integration with CRM. The materials describe the creation of objects and the addition of related data: files, requisites, CRM activities, documents, and settings for Smart Process Automation (SPA).

You can select a scenario based on the CRM entity, the integration result, and the main REST methods.

Choose the Type of ObjectChoose the Type of Object

Start by selecting the base object. The choice depends on the stage of interaction with the client and the source of the data.

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

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

Deal. Necessary to initiate a commercial process. A deal is usually created along with a company and requisites if the purpose of the inquiry is a sale.

Scenarios for Main ObjectsScenarios for Main Objects

Scenario	Main Methods	Result
Add Lead via Web Form	crm.lead.add	ID of the new lead
Add Duplicate Lead	crm.duplicate.findbycomm, crm.lead.list, crm.lead.add	ID of the new duplicate lead after checking for duplicates
Add Contact via Web Form	crm.contact.add	ID of the new contact
Add Company via Web Form	crm.company.add	ID of the new company
Add Deal and Company with Requisites	crm.company.add, crm.requisite.add, crm.deal.add	ID of the company, requisite, and deal

Work with Related DataWork with Related Data

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

Requisites and Addresses. Bank requisites and legal addresses are stored separately from contacts and companies. First, obtain the requisite templates, then create the object and link the address to it.

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

Vendors. A vendor is a separate type of object for procurement and warehouse documents. Use universal CRM and catalog methods to add a vendor.

Scenarios for Related DataScenarios for Related Data

Scenario	Main Methods	Result
Add Lead with Files via Web Form	crm.lead.add, crm.lead.userfield.add	ID of the lead with populated file fields
Add Contact with Requisites via Web Form	crm.contact.add, crm.requisite.add, crm.address.add	ID of the contact, requisite, and address
Add Company with Requisites via Web Form	crm.company.add, crm.requisite.add, crm.address.add	ID of the company, requisite, and address
How to Create a Vendor in CRM	crm.category.list, crm.item.add, catalog.documentcontractor.add	ID of the vendor for warehouse documents

Add Activities and DocumentsAdd Activities and Documents

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

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

CRM Mode Consideration. The CRM mode determines where a new inquiry will go: to a lead or directly to a deal. If the integration needs to work across different accounts, check the CRM mode before creating an activity.

Documents. Document generation occurs based on templates. First, set up the numbering and upload the template, then create the document linked to the CRM entity.

Scenarios for Activities and DocumentsScenarios for Activities and Documents

Scenario	Main Methods	Result
Add Activity to New Lead or Deal Depending on CRM Mode	crm.settings.mode.get, crm.deal.list, crm.activity.todo.add	ID of the activity linked to the lead or deal
Add Calendar Event for Client Interaction	crm.contact.get, crm.activity.add	ID of the activity of type "Event"
How to Send an E-mail to a Client on Behalf of an Employee	crm.contact.get, crm.activity.add	ID of the activity 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	ID of the document and link to the file

Configure Smart ProcessesConfigure Smart Processes

If the standard CRM objects are insufficient, use Smart Processes. These are custom CRM types with their own fields, funnels, and stages.

Object Type (entityTypeId). A key parameter for working with Smart Processes. Obtain it before calling API methods, configuring fields, or comments.

Funnels and Stages. Set up the process for passing through stages. Create a funnel and add the necessary statuses.

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

Scenarios for Smart ProcessesScenarios for Smart Processes

Scenario	Main Methods	Result
How to Add a Comment to the Smart Process Timeline	crm.type.list, crm.item.list, crm.timeline.comment.add	ID of the timeline record
How to Create a Custom Field in a Smart Process	crm.type.list, userfieldconfig.add	ID of the custom field
How to Set Up Rounding for a Custom Field of Type "Number"	crm.userfield.settings.fields, crm.deal.userfield.list, userfieldconfig.update	Updated settings for the numeric field
How to Create a New Funnel with Stages in a Smart Process	crm.type.list, crm.category.add, crm.status.add	ID of the funnel and created stages