Linking Module APIs
Linking module is a sort of intermediary module that provides a bridge to associate the records from two different modules. For instance, if a Lead record and a Contact record are to be associated through a lookup or multi-select lookup fields, a new record is created in the linking module which contains the information pertaining to the association of the records from the both Leads and Contacts.
Hence, each association between records in any two modules is the creation of a new record in the linking module. Naturally, the association is terminated once the record in the linking module is deleted.
This capability enables a more integrated approach to managing data, facilitating better insights and workflows across the CRM system.
Types of Relationships
- One-to-many - Here, one record in the parent module can be linked to multiple records in the child module. For example, one Contact can have multiple associated Deals.
- Many-to-one - In this case, multiple records in the child module can be associated to a single record in the parent module. For instance, associating multiple Leads with one Campaign.
- Many-to-many - This relationship allows records from one module to be linked to multiple records in another module. For example, multiple Contacts can be linked to multiple Deals.
Scope
ZohoCRM.modules.all
(or)
ZohoCRM.modules.custom.{operation_type}
Possible operation types
ALL - Full access to the record
READ - Get records from the module
WRITE - Create, Update and Delete records in a module
CREATE - Create records in a module
UPDATE - Update records in a module
DELETE - Delete records from a module
You can establish a relationship between records of two module and get their details in the following APIs.
Records APIs:
Related List APIs:
Note
- You can manipulate the records of a linking module only in Enterprise and above editions of Zoho CRM.
- Mandatory fields in a linking module are two lookup fields from the modules to be associated.
- A maximum of 100 custom fields are available for a linking module.
- You can choose the visibility of the linking module in the CRM UI.
- To get records from the related lists, in the fields parameter of the API call, enter {linking_module_api_name}.{field_api_name}, to get the record.
- There are no other changes in the API calls specific to linking modules.
- Refer to the Insert Records API for sample inputs to insert data to lookup and multi-select lookup fields.