Kaizen #199: FAQs on Multi-Select Lookup (MxN) Field in Zoho CRM
Nearing 200th Kaizen Post – We want to hear from you!
Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.
Hey everybody!!!
Welcome back to another post in the Kaizen series!
In this post, we will address some of the most frequently asked questions about the Multi-Select Lookup(MxN) field from the Zoho CRM developer community forum.
1. What is a Multi-select lookup field?
A multi-select lookup field in Zoho CRM lets you create a many-to-many relationship between two modules. This means a record in one module can be linked to multiple records in another module and vice versa.
For example, using an multi-select lookup field, you can associate multiple skills with an employee.
2. How does the Mutli-Select Lookup relationship work?
When you create a Multi-Select Lookup between two modules, for example, Employees and Skills, Zoho CRM automatically creates a hidden linking module, which is also known as an MxN module. This module stores the associations between records in the two modules, enabling you to track and manage many-to-many relationships.
For instance, if you link Employees and Skills, a linking module named EmpXSkills will be created.
This linking module is accessible only via API.
Backend Flow of multi-select lookup Relationship
In the linking module, two lookup fields (lookup fields with api names - Employees and Skills) will be created. The lookup fields, one pointing to Employees and the other pointing to Skills from the linking module, establish a connection between the linking module and its associated module.
Why you cannot use a lookup field for this use case?
In Zoho CRM, a lookup field creates a one-to-many relationship between two modules i.e. one record in the source module can be linked to only one record in the target module.
Example :
If you create a lookup field for Skills in the Employees module, each employee can be linked to only one skill. So, use a multi-select lookup field instead of a lookup field when you need to represent complex relationships like one employee - many skills and one skill - many employees.
3. How to create a multi-select Lookup field using Zoho CRM APIs?
To create a Multi-Select lookup field between two modules using Zoho CRM APIs, follow these steps:
Step 1: Identify the Module API Name
Before creating the field, you should know the API names of the Employees and Skills modules. For that, use the Get Module Metadata API.
Request URL : {{api-domain}}/crm/v8/settings/modules
Request method : GET
Now, search for the Employees module in the response and note its API name.
Step 2: Use the Create Custom Fields API
To establish a many-to-many relationship between two modules, in our case, Employees and Skills, you need to create a custom field of type multi-select lookup in the Employees module (parent module). Here, we will associate multiple skills to an employee.
This custom field requires:
- The related module you want to link to - Skills.
- A display field from the related module
- The linking module (EmpXSkills), which stores the actual associations.
Use the Create Custom Fields API to create custom fields.
Request URL : {{api_domain}}/crm/v8/settings/fields?module=Employees
Request method : POST
Sample input :
|
{
"fields": [
{
"field_label": "Skills", //Name of the field in your module
"data_type": "multiselectlookup", //Type of the field
"multiselectlookup": { //This JSON object contains the multi-select lookup relationship details
"connected_details": { //Details about the module and field you want to link
"module": {
"api_name": "Skills" //API name of the related module
},
"field": {
"field_label": "Skills" //The field in the related module to display
}
},
"linking_details": { //Details about the junction or linking module that manages the many-to-many relationship
"module": {
"plural_label": "EmpXSkills" //Plural label of the junction module
}
}
}
}
]
}
|
4. How Do You Find the Linking Module and Field API Names?
To know the API name of the linking module:
Use the Get Modules API and search for "generated_type" : "linking" in the response to identify MxN modules. In our case, EmpXSkills.
Request URL : {{api_domain}}/crm/v8/settings/modules
Request method : GET
To know the field API names in the linking module:
Use the Get Fields Metadata API to retrieve the API names of lookup fields within the linking module.
Request URL : {{api_domain}}/crm/v8/settings/fields?module=EmpXSkills
Request method : GET
5. How do I associate records via a multi-select lookup field using the Insert Records API in Zoho CRM?
To associate records using a multi-select lookup field, you must provide the record IDs from the related module. The association is made through the linking module.
Example :
Associating multiple skills with an employee using the multi-select lookup field.
Request URL : {{api-domain}}/crm/v8/Employees
Request method : POST
Sample input :
|
{
"data": [
{
"Name": "Patricia",
"Email": "patricia@mail.com",
"Position": "Marketing Specialist",
"Year_of_Experience": 5,
"Skills": [ // API name of the multi-select lookup field in the Employees module
{
"Skills": { // API name of the lookup field in the linking module pointing to the Skills module
"name": "Marketing",
"id": "5725767000002149427" //ID from the Skills module are mandatory to establish the link
}
},
{
"Skills": {
"name": "Social Media Marketing",
"id": "5725767000002149476"
}
}
]
}
]
}
|
6. How do I associate an Employee's skills using the linking module in Zoho CRM?
To establish a relationship between the Employees and Skills modules through the linking module, use the Insert Records API to create a record in the linking module, EmpXSkills.
To do this,
- Use the appropriate lookup field API names to reference the parent module.
- You must need the record IDs from both the Employees and Skills modules to create the associations.
Request URL : {{api-domain}}/crm/v8/EmpXSkills
Request method : POST
Sample input :
|
{
"data": [
{
"Name": "Patricia",
"Employees": {
"id": "5725767000002161001" // Record ID from the Employees module
},
"Skills": {
"id": "5725767000002149476" // Record ID from the Skills module
}
}
]
}
|
7. When should I use create/update operations in the Employees module vs the EmpXSkills module?
|
Employees Module |
EmpXSkills (linking) Module |
|
Use when you want to create or update an Employee and associate Skills using the Multi-select Lookup field. |
Use when you want to create or remove associations between existing Employee and Skill records without modifying the actual Employee or Skill data. |
|
Creating a new employee and assigning their skills at once. |
Managing relationships between existing records i.e., linking and unlinking skills to employees. |
8. How to update a record in the linking module?
To update a record in the linking module, use the Update Records API.
Request URL : {{api-domain}}/crm/v8/EmpXSkills/5725767000006269044
Request method : PUT
Sample input :
|
{
"data": [
{
"Skills": {
"name": "Marketing",
"id": "5725767000002170035" //Associating another skill with the employee
}
}
]
} |
In the above sample, we have replaced an existing skill associated with an employee with another Skill in the linking module.This is done by updating the Skills lookup field in the EmpXSkills record.
Please note that in the linking module, Skills is a lookup field, so you can associate only one skill per linking record. But in the Employees module, Skills is a multi-select lookup field, so an employee can be associated with multiple skills.
9. How to unlink records from the parent module as well as the linking module?
Unlink the associated records from the parent module:
Using the Update records API, you can remove an associated skill from an employee, use the "_delete": null key within the multi-select lookup field in the Employee record update.
Request URL : {{api-domain}}/crm/v8/Employees/5725767000006269044
Request method : PUT
Sample input :
|
{
"data": [
{
"Skills": [
{
"Skills": {
"name": "Marketing",
"id": "5725767000002170035" // The Skill record you want to unlink
},
"id": "5725767000007228047", //record ID - The record created in the linking module for the employee with the Marketing skill
"_delete" : null
}
]
}
]
}
|
Replace an associated record from the linking module:
Use the Update Records API to replace an existing association in the linking module.
Request URL : {{api-domain}}/crm/v8/EmpXSkills/5725767000007228035
Request method : PUT
Sample input :
|
{
"data": [
{
"Skills": {
"name": "Java",
"id": "5725767000005259075" //replacing a new skill
}
}
]
}
|
In the above sample, we have replaced the existing skill with Java.
10. Why am I seeing the error "DUPLICATE_LINKING_DATA" in the Update Records API?
This error occurs when you try to associate records with the parent record that are already linked with the Multi-select lookup field. To resolve this, check the records you are trying to link and make sure your association is only with records that are not already linked.
Know your existing linked records:
Before the Update Records API, use the Get Related Records Data API and search for the multi-select lookup field. In our case, Skills is the multi-select lookup field created in the Employees module. This will return all records already associated.
Example :
The response returns all Skills already linked with that Employee.
Using this way, compare the IDs from the API response with the new records you are about to link, and only proceed with non-duplicate IDs. This avoids duplicate entries and prevents the "DUPLICATE_LINKING_DATA" error.
11. What happens if I delete a record in the linking module?
When you delete a record in the linking module, it only removes the association between the related records in the Employees and Skills modules.
Note :
- Deleting a linking module record removes only the relationship between two records from the Employees and Skills modules.
- Deleting an Employee or Skill record deletes all corresponding entries in the linking module as well.
12. How do I query linked records?
Use the COQL API to query multi-select lookup data by specifying the corresponding linking module's API name directly in your query. The linking module is treated as a separate module in Zoho CRM, so you can retrieve associated records by querying it like any other module.
Sample query :
|
{
"select_query": "select Skills.Name as skill, Employees.Name as employee from EmpXSkills where Skills.Name like '%Marketing%'"
}
|
Use the Get Module Metadata API to know the linking module's API name.
13. How do I export multi-select lookup records using the Bulk Read API?
To export multi-select lookup data, linking module records efficiently, use the Bulk Read API with the linking module’s API name.
Request URL : https://www.zohoapis.com/crm/bulk/v8/read
Request method : POST
Sample Request :
|
{
"callback": {
"method": "post"
},
"query": {
"module": {
"api_name": "EmpXSkills" //API name of the linking module
},
"fields": [
"Employees.Name",
"Employees.Year_of_Experience",
"Skills.Name"
],
"criteria": {
"group": [
{
"field": {
"api_name": "Employees.Year_of_Experience"
},
"comparator": "greater_than",
"value": "4"
},
{
"field": {
"api_name": "Skills.Name"
},
"comparator": "contains",
"value": "Social"
}
],
"group_operator": "AND"
}
}
}
|
14. Can I import my linking module's data using the Bulk Write API?
Yes. Like the Leads and Contacts modules, you can also import linking module's data into Zoho CRM using the Bulk Write API by directly specifying the linking module’s API name.
If you are importing data that involves both a parent module, Employees and its associated MxN linking module, follow these steps:
1. Create separate CSV files:
- One for the parent module - Employees
- One for the linking module - EmpXSkills
2. Zip the files into a single ZIP file.
3. Upload the ZIP in a single Bulk Write API request.
4. Ensure accurate field mappings are provided in the API request body.
Refer to Kaizen #131 - Bulk Write for parent-child records using Scala SDK for more details on handling parent-child records.
15. Can I receive notifications if a multi-select lookup field in a module is modified or updated?
Yes, you can receive notifications when a MxN field is updated using the Notification API. To enable instant notifications for actions performed in a module, use the respective API names of the linking module in the input body.
Request URL : https://www.zohoapis.com/crm/bulk/v8/actions/watch
Request method : POST
Sample input :
|
{
"watch": [
{
"channel_id": "10000",
"events": [
"EmpXSkills.all" //EmpXSkills represents the API name of the linking module
],
"notify_url": "https://webhook.site/9f5ba227-ce5a-4709-814d-b044c003d605",
"return_affected_field_values": true
}
]
}
|
16. Can I use criteria-based filtering when accessing multi-select lookup data using the Search API?
Yes, you can filter multi-select lookup data using the criteria parameter in the Search API's URL.
Here is an example that fetches records from the EmpXSkills linking module.
Request URL : {{api-name}}/crm/v8/EmpXSkills/search?criteria=((Secondary_Email:equals:patricia@mail.com)and(Skills:equals:Content_Marketing))
Request method : GET
Sample response :
x-----------------------------x
We trust that this post meets your needs and is helpful. Let us know your thoughts in the comment section or reach out to us at support@zohocrm.com
Stay tuned for more insights in our upcoming Kaizen posts!
Previous Kaizen Post : Kaizen #198: Using Client Script for Custom Validation in Blueprint | Kaizen Directory
Other FAQs in the Kaizen series :
- Kaizen#75 - Frequently Asked Questions on Client Script
- Kaizen #147 - Frequently Asked Questions on Zoho CRM Widgets
- Kaizen #155 - Frequently Asked Questions on Subforms
- Kaizen #170 - Frequently Asked Questions on Notification APIs
- Kaizen #195: Frequently Asked Questions on Bulk Read API and Bulk Write API
Access your files securely from anywhere
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Subramanian K
Sticky Posts
Kaizen #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achievedKaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script
Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.Kaizen #210 - Answering your Questions | Event Management System using ZDK CLI
Hello Everyone, Welcome back to yet another post in the Kaizen Series! As you already may know, for the Kaizen #200 milestone, we asked for your feedback and many of you suggested topics for us to discuss. We have been writing on these topics over theKaizen #197: Frequently Asked Questions on GraphQL APIs
🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Kaizen #198: Using Client Script for Custom Validation in Blueprint
Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
Automatically Add Recurring Zoho Meeting Events to Zoho Calendar / Zoho Meeting Calendar
Hello Zoho Meeting Team, Hope you are doing well. We would like to request an enhancement regarding recurring meetings created inside Zoho Meeting. At the moment, when we schedule a recurring meeting in Zoho Meeting, it does not appear in Zoho CalendarLimited layout rules in a module
There is a limit of 10 layout rules per module. Is there a way to get that functionality through different customization or workflow + custom function (easily accessible), etc. Having just 10 is limiting especially if module contains a lot of data. AreEnhance Sign CRM integration
Hello all, I'm working on a custom Deluge script to enhance the integration between Zoho CRM and Sign by using a writer merge template for additional flexibility. I want to replicate the post-sign document integration that exists between CRM and SignPython - code studio
Hi, I see the code studio is "coming soon". We have some files that will require some more complex transformation, is this feature far off? It appears to have been released in Zoho Analytics alreadyGood news! Calendar in Zoho CRM gets a face lift
Dear Customers, We are delighted to unveil the revamped calendar UI in Zoho CRM. With a complete visual overhaul aligned with CRM for Everyone, the calendar now offers a more intuitive and flexible scheduling experience. What’s new? Distinguish activitiesReplacing email ID,
In zoho sheets If I am sending it as an email attachments can I replace sender email ID from notifications to my email ID.Move orders scan ISBN
Hi We have ISBN setup to be searched in items zoho but move orders dissent recognize the ISBN is there q missing configuration? regards, JSViewID and Zoho Desk API
I'm looking at the documentation for Listing contacts and it looks like you can filter by ViewID. I assume this is views created in a department or all departments. Is this correct? And if so, how do I find the ViewID for that view? EDIT: I see the viewAbility to Link Reported Issues from Zoho Desk to Specific Tasks or Subtasks in Zoho Projects
Hi Zoho Desk Team, Hope you're doing well. When reporting a bug from Zoho Desk to Zoho Projects, we’ve noticed that it’s currently not possible to select an existing task or subtask to associate the issue with. However, when working directly inside ZohoAutomatically Update Ticket Status in Zoho Desk Based on Actions in Zoho Projects
Hi Zoho Desk Team, Hope you’re doing well. We’re using the Zoho Desk–Zoho Projects integration to manage tasks related to customer tickets, and it works well for linking and tracking progress. However, there are a few important automation capabilitiesPrint Tickets
We have field engineers who visit customers. We would like the option to print a job sheet with full details of the job and account/contact details.Zoho Desk integration with Power BI
Hi, I want to be able to create a Power BI report which has live updates of ticket data from zoho desk, is this possile at all? Thanks JackAbility to Attach Images When Reporting Issues to Zoho Projects from Zoho Desk
Hi Zoho Desk Team, Hope you’re doing well. We’re using the Zoho Desk–Zoho Projects integration to report bugs directly from support tickets into the Zoho Projects issue tracker. This integration is extremely useful and helps us maintain smooth coordinationAbility to Choose Task List and Add Subtasks When Creating Tasks from Zoho Desk
Hi Zoho Desk Team, Hope you’re doing well. We’re using the Zoho Desk–Zoho Projects integration to seamlessly connect customer tickets with project tasks. While the integration works great overall, we noticed two important limitations that affect our workflowSync Task Status from Zoho Projects to Zoho Desk
Hi Zoho Desk Team, Hope you’re doing well. We’re actively using the Zoho Desk–Zoho Projects integration, which helps our support and project teams stay aligned. However, we noticed that when we change a task’s status in Zoho Projects, the change is notDefault/Private Departments in Zoho Desk
1) How does one configure a department to be private? 2) Also, how does one change the default department? 1) On the list of my company's Zoho Departments, I see that we have a default department, but I am unable to choose which department should be default. 2) From the Zoho documentation I see that in order to create a private department, one should uncheck "Display in customer portal" on the Add Department screen. However, is there a way to change this setting after the department has been created?Retainer invoice in Zoho Finance modlue
Hello, Is there a way of creating retainer invoices in the Zoho Finance module? If not can I request this is considered for future updates please.Can we do Image swatches for color variants?
We want to do something like the attached screenshot on our new zoho store. We need image swatches instead of normal text selection. We want to user to select an image as color option. Is this doable? I don't see any option on zoho backend. Please hHow Zoho Desk contributes to the art of savings
Remember the first time your grandmother gave you cash for a birthday or New Year's gift, Christmas gift, or any special day? You probably tucked that money safely into a piggy bank, waiting for the day you could buy something precious or something youZoho CRM IP Addresses to Whitelist
We were told to whitelist IP addresses from Zoho CRM. (CRM, not Zoho Mail.) What is the current list of IP Addresses to whitelist for outbound mail? Is there a website where these IP addresses are published and updated? Everything I could find is overColor of Text Box Changes
Sometimes I find the color of text boxes changed to a different color. This seems to happen when I reopen the same slide deck later. In the image that I am attaching, you see that the colors of the whole "virus," the "irology" part of "virology," andThe difference between Zoho Marketing Automation and Zoho Campaigns
Greetings Marketers! This post aims to differentiate between Zoho Marketing Automation and Zoho Campaigns. By the time you get to the end of the post, you will be able to choose a product that objectively suits you. What is Zoho Marketing Automation?When moments in customer support get "spooky"
It’s Halloween again! Halloween is celebrated with spooky symbols and meanings based on history and traditions, with each region adding its own special touch. While we were kids, we would dress up in costumes along with friends, attend parties, and enjoyHow to use Rollup Summary in a Formula Field?
I created a Rollup Summary (Decimal) field in my module, and it shows values correctly. When I try to reference it in a Formula Field (e.g. ${Deals.Partners_Requested} - ${Deals.Partners_Paid}), I get the error that the field can’t be found. Is it possibleZoho Mail Android app update - View emails shared via Permalink on the app.
Hello everyone! In the latest version(v2.8.2) of the Zoho Mail Android app update, we have brought in support to access the emails shared via permalink within the app. Earlier, when you click the permalink of an email, you'll be redirected to a mobileLet us view and export the full price books data from CRM
I quote out of CRM, some of my clients have specialised pricing for specific products - therefore we use Price Books to manage these special prices. I can only see the breakdown of the products listed in the price book and the specialised pricing forWeekly Tips: Manage External Images in Zoho Mail
When you receive emails every day, whether from clients, newsletters, or services, many of them contain external images that automatically load when you open the message. While this can make emails look more engaging, it can also impact your privacy andEmpowered Custom Views: Cross-Module Criteria Now Supported in Zoho CRM
Hello everyone, We’re excited to introduce cross-module criteria support in custom views! Custom views provide personalized perspectives on your data and that you can save for future use. You can share these views with all users or specific individualsHow to display Motivator components in Zoho CRM home page ?
Hello, I created KPI's, games and so but I want to be able to see my KPI's and my tasks at the same time. Is this possible to display Motivator components in Zoho CRM home page ? Has someone any idea ? Thanks for your help.Introducing Record Summary: smarter insights at your fingertips
Hello everyone, We’re excited to introduce the Record Summary feature. This powerful addition makes use of Zia to simplify how you interact with your CRM data, providing a seamless, consolidated view of critical record information. Scrolling through theAccount in Quick View Filter
I have a report that I often run against a specific Account. Every time, I have to go into the edit menu and change the Advanced Filter. I would prefer to use the Quick View Filter, but it does not allow me to use the one and only field that makes anyInsert Cookie Policy in Zoho Sites
Hello, i need to insert a banner on my site because i'm in Italy so i have to respect EU laws for Cookie Policy and Privacy Policy. I see that i need to insert a code in <head> section of my site to show a banner/popup with cookie info. How i can do this? Thank you LucaCliq iOS can't see shared screen
Hello, I had this morning a video call with a colleague. She is using Cliq Desktop MacOS and wanted to share her screen with me. I'm on iPad. I noticed, while she shared her screen, I could only see her video, but not the shared screen... Does Cliq iOS is able to display shared screen, or is it somewhere else to be found ? RegardsUnable to confirm Super Admin assignment — confirmation button not working
I’m trying to change the roles within my organization. I am currently a super admin and would like to add another user as a super admin. When I attempt to confirm the action, a screen appears asking for my password to verify my identity. However, whenDelegates should be able to delete expenses
I understand the data integrity of this request. It would be nice if there was a toggle switch in the Policy setting that would allow a delegate to delete expenses from their managers account. Some managers here never touch their expense reports, andLet's Talk Recruit: Meet Zia, your all-in-one AI assistant (Part-2)
Welcome back to Let’s Talk Recruit series. In Part 1, we introduced Zia and how AI is reshaping the way recruiters work. This time, we’re taking a closer look at how far Zia has come and how each update continues to simplify your everyday tasks. WhenFunction #9: Copy attachments of Sales Order to Purchase Order on conversion
This week, we have written a custom function that automatically copies the attachments uploaded for a sales order to the corresponding purchase order after you convert it. Here's how to configure it in your Zoho Books organization. Custom Function: Hitstock
bom/bse : stock details or price =STOCK(C14;"price") not showing issue is #N/A! kindly resolve this problemKaizen #8 - Handling Recurrence and Participants in the Events Module via API
Hello everyone! We are back this week with an exciting post—Handling recurrence and participants in the Events module through API. First things first—What is the Events module? "Events" is a part of the Activities module in Zoho CRM. An event is an activity that happens at a given place and time. You can find Events on the user's Zoho CRM's home page, Activities home page, Calendar, and in other related records. What are the types of Events? Events are of two types—Recurring and non-recurring events.Marketer’s Space - Get Holiday-Ready with Zoho Campaigns
Hello marketers, Welcome back to another post in Marketer’s Space! Q4 is packed with opportunities to connect with your audience - from Halloween, Black Friday, and Cyber Monday, to Thanksgiving, Christmas, and New Year. In this post, we’ll look at howNext Page