Contacts in CRM: Overview of Methods
A contact is a CRM object that stores data about clients—individuals. The contact card contains phone numbers, email addresses, and messenger identifiers in a special format that allows communication with the client directly through Bitrix.
Quick navigation: all methods and events
User documentation: contacts in Bitrix24
Contact Connection with Other CRM Objects
Deal, lead, SPA. Any CRM object that has the standard field Client is connected to contacts. The connection is managed through groups of methods for deals, leads, and SPAs.
Company. A single contact can be linked to multiple companies. This connection is managed using the group of methods crm.contact.company.*. When you select a company in the Client field in deals or SPAs, all associated contacts are automatically pulled into the field.
Requisites. The requisites themselves are a separate object, and methods from the group crm.requisite.* and crm.address.* are used to create or modify them. They are displayed in the Requisites field of the contact card.
User Documentation
Contact Card
The main workspace in a contact 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 you to store information in various data formats: string, number, link, address, and others. The group of methods crm.contact.userfield.* is used to create, modify, retrieve, or delete custom contact fields.
-
The right part contains the contact's timeline. In it, you can create, edit, filter, and delete CRM activities using the group of methods crm.activity.*, and timeline records using the group of methods crm.timeline.*.
The parameters of the contact card can be managed through the group of methods crm.contact.details.configuration.*.
User Documentation
Widgets
You can embed an application into the contact card. Thanks to embedding, you can use the application without leaving the contact card.
There are two embedding scenarios:
- Use special embedding locations. For example, by creating your own tab.
- Create a custom field where the interface of your application will be loaded.
Typical use-cases and scenarios
Overview of Methods and Events
Scope:
crmWho can perform methods: depending on the method
Basic
|
Method |
Description |
|
Creates a new contact |
|
|
Updates an existing contact |
|
|
Returns a contact by ID |
|
|
Returns a list of contacts by filter |
|
|
Deletes a contact and all associated objects |
|
|
Returns the description of contact fields, including custom fields |
|
Event |
Triggered |
|
When a contact is created |
|
|
When a contact is updated |
|
|
When a contact is deleted |
Companies
|
Method |
Description |
|
Adds a company to the specified contact |
|
|
Retrieves the set of companies associated with the specified contact |
|
|
Sets the set of companies associated with the specified contact |
|
|
Removes a company from the specified contact |
|
|
Clears the set of companies associated with the specified contact |
|
|
Returns the description of fields for contact-company connection |
Custom Fields
|
Method |
Description |
|
Creates a custom field for contacts |
|
|
Modifies an existing custom field for contacts |
|
|
Returns a custom field for contacts by Id |
|
|
Returns a list of custom fields for contacts |
|
|
Deletes a custom field for contacts |
|
Event |
Triggered |
|
When a custom field is added |
|
|
When a custom field is updated |
|
|
When a custom field is deleted |
|
|
When the set of values for a list-type custom field is changed |
Managing Contact Cards
|
Method |
Description |
|
Retrieves the settings of contact cards |
|
|
Resets the settings of contact cards |
|
|
Sets the settings of contact cards |
|
|
Allows forcing a common contact card for all users |