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
Formula Fields Trouble
Hi, I can't get even a simple formula field to work and must be doing something dumb. This formula: If(Len(Trim(${Quotes.Subject}))=0,1,2) Gives the error: You used the wrong type of data in an argument. Check what you entered between the parentheses of your functions to make sure you put the right kind of data in the right place. This formula: Len(Trim(${Quotes.Subject}))=0 Gives the error: Syntax Error. Check the examples for any functions you're using to see if you formatted them correctly. MakeOPTED FOR STORAGE BY DESCRIPTIVE MISGUIDANCE
We've opened a domain with three mail ids and payment has also been processed now the bill raised is for single use ID with additional storage capacity. Kindly request you to modify the purchase.How can I add a new organization on Zoho Campaign
I want to create a new organization with my Zoho CampaignWhite Label certificate
Hi all, About 72 hours ago, we fulfilled all steps for white labeling (CNAME to point to mail.cs.zohohost.eu), but since then the configuration page is now stuck at "generating certificate" since 3 days. When I execute an NSLOOKUP mail.webfoundry.be itwww.abc.com is working but abc.com is not
I have my domain in godaddy. I have created a website using zoho sites and now I want to publish it and I tried doing it. Mapped the domain www.abc.com, abc.com. In godaddy changed the CNAME values. A, @ was parked and updated with zoho's IP address.Split my account
Hello, I recently bought an email service for a friend. But, looks like I used my personal account to buy the plan. Please split the account so that the email service stays in a different account than my personal account.Have Mail Lite, wish to add/purchase 2nd domain and use email
Hello, I have recently created two new businesses. I have successfully used Zoho to create a domain for one business and have set up two email addresses / users on that domain. I am trying to figure out how to create a second domain, just like I did theNeed support in setting up the company email and few other setups
Need support in setting up the company email and few other setupsThis mobile number has been marked spam.
Dear zoho team, I am very happy to use zoho,because it india 🇮🇳 own app, but when we login into zoho account we facing some issue, please solve below issue ASAP. Add your mobile number As an added security measure for Accounts, you need to verify andAdd an external email to the allowed list
I need to allow an external email to raise a ticket on Manage Engine ServiceDesk Plus. The external email is a outside of our domain and is not a domain user. The email address that needs to be allowed to raise a ticket request is noreply@formsatack.com.Display name & account type change
I made a mistake and subscribed with an individual account instead of business, how can I change the account type and enter the details of the business. The other question, if I can't, then I want the display name of our email to be 'Business name' insteadRequest to change display name in Zoho mail
Hello Zoho Mail Support, I am experiencing an issue with changing the display name on my Zoho Mail account. My email address is: info@witchcraftproduction.rs . I have already updated the display name in Settings > Mail Accounts, where it now shows asOutbound IP address SPAM problem.
Hello Zoho Support, We noticed that one of your outbound IP addresses (136.143.188.12), which delivers our domain’s mail, is currently listed on the UCEProtect blacklist. Because of this, our messages are sometimes flagged as spam by recipient servers.Answer Bot and Personalized Questions
Hi there, I have the same problem using the SalesIQ Answer Bot and the Zoho Desk Answer Bot (which really need different names, to be honest, in order to avoid confusion...) Customers that visit our website ask questions in the form of "What do you do?"Forwarding
How can I forward my Zoho account to my gmail account? NoëlAdd a Way to Duplicate Cards in the Same Canvas (Retain All Settings)
Dear Zoho SalesIQ Team, We would like to request a new feature in Zoho SalesIQ: the ability to duplicate an existing card within the same canvas while retaining all of its information and settings, including conditions, configurations, and display preferences.Zoho Mail CC and BCC not working
Zoho Mail CC and BCC not working. I have tried multiple combinations amongst my domain aliases but emails sent as CC or BCC never arrive, not even to Spam. I have checked that the DNS is set up correctly in Cloudflare and have even received a DMARC reportZoho Autoplay Issue
Currently, we run our graphics on a playlist with youtube videos interspersed in our office -- however, when we go to update the playlist (since last Thursday at around 8-9am EST) it no longer saves the autoplay function. We have tried making a new account, manually saving with cntrl+s, making a new show, etc but nothing seems to work. Even with our old program, we can't change it off of autoplay for ones that were created in the past. Another issue is that if we change a slide transition to anythingCritical Issue: Tickets Opened for Zoho Support via the Zoho Help Portal Were Not Processed
Hi everyone, We want to bring to your attention a serious issue we’ve experienced with the Zoho support Help Portal. For more than a week, tickets submitted directly via the Help Portal were not being handled at all. At the same time no alert was postedAdding hyperlinks in CRM emails time automatically
It may just be me, but when I am writing an email to a lead, I find inserting a hyperlink very time consuming. Granted, I can use templates but there are a ton of scenarios where I might want to put a link in to an website that wouldnt require me to go though the effort of creating a template. Ideally, the crm would identify that I that a string of text is a URL and insert the hyperlink automatically, just like microsoft outlook or gmail. Has anyone else had this same experience and found a wayEnhance "Applications Usage" with Date Filters, Historical Analytics & App-Level Breakdown
Hello Zoho Creator Team, We are writing to request a critical enhancement to the Applications Usage section to improve our ability to monitor, analyze, and manage our platform consumption over time. While the current view of today’s usage is helpful forExternal File Share - Allow delete
Hi Team, when I share an external link and give it edit rights the external user can add but not delete files and folders. what am i doing wrong?How to notify all members on any updates to zoho crm?
Hi, I am using the free version of zoho CRM and currently seeing this will work for our company. We are a small company and wanted to be more informed about all the changes in zoho. 1. How do I s et notifications that go to the team for any and all changesHow to change the format for phone numbers?
Mobile phone numbers are currently formatted (###) ###-####. How can I change this to a more appropriate forms for Australia being either #### ### ### or (#)### ### ###?Unattended Access on Android without Play Store
I'm testing Zoho Assist for remote config and maintenance of our IoT devices. The devices are running Android 8.1 and do NOT have Google Play Store installed, nor can it be installed. I've been able to install Zoho Assist on the devices and load the enrollmentOpen Sans Font in Zoho Books is not Open Sans.
Font choice in customising PDF Templates is very limited, we cannot upload custom fonts, and to make things worse, the font names are not accurate. I selected Open Sans, and thought the system was bugging, but no, Open Sans is not Open Sans. The realIs it possible to embed Zoho Bookmarks in the Cliq sidebar?
Is there any way that each Zoho user can access their bookmarks (that live in https://bookmarks.zoho.eu/ which is technically a part of Zoho Mail) directly within Cliq? As a widget, or an item in the sidebar? My team does not use Mail, it uses Cliq allShow Attachments in the customer portal
Hi, is it possible to show the Attachments list in the portal for the particular module? Bests.Kaizen #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.Navigate with Ease: Announcing Improvements to Your Zoho CRM for Everyone's Setup Experience
Hello Everyone, We’re thrilled to announce new enhancements to the Setup Menu in our Zoho CRM for Everyone system, designed to simplify your workday and streamline your overall experience. What's New? Addition of a Setup Homepage Faster Search in SetupZoho Projects Webhook fails with HTTP Error 0
Hello Zoho Community, I am pulling my hair out over this one. I have setup a very basic http(s) server that always responds "ok" and code 200 to incoming GET requests. It will accept any parameters, and any path. Really, all it does is say "ok," and logZOHO Campaignで表のカラムの幅を調整したい。
表を作成した際、個々のカラムの幅を調整したいのですが、方法が分かりません。 どなたかご存じの方ご教示ください。Auto-upload Creator Files to WorkDrive
Hi everyone, I’m working on a workflow that uploads files from Zoho Creator to specific subfolders in Zoho WorkDrive, as illustrated in the attached diagram. My Creator application form has two multi-file upload fields, and I want—on successful form submission—toExciting Updates to the Kiosk Studio Feature in Zoho CRM!
Hello Everyone, We are here again with a series of new enhancements to Kiosk Studio, designed to elevate your experience and bring even greater efficiency to your business processes. These updates build upon our ongoing commitment to making Kiosk a powerfulKaizen #129 : Client Script Support for Blueprints
Hello everyone! Welcome to another week of Kaizen. Today, let us discuss about how you can use Client Script during a Blueprint transtion to meet your requirements. This Kaizen post will provide solution for the post - Need non-mandatory fields in blueprintSearch Bar Improvement for Zoho Commerce
Hey everyone, I've been using Zoho Commerce for a bit now, and I think the search bar could really use an upgrade. Right now, it doesn't show products in a dropdown as you type, which would make finding items a lot faster. On Shopify, for example, youMaking digital signatures accessible to all: Introducing accessibility controls in Zoho Sign
Hi there! At Zoho Sign, we are committed to building an inclusive digital experience for all our users. As part of our ongoing efforts to align with Web Content Accessibility Guidelines (WCAG), we’re updating the application with support that will goAccount Owner Field From Accounts Module to be Displayed in Contacts module
I have a field in the Accounts Module in the CRM called "Account Owner" i want that field to be also mapped into the Contacts Module custom single line field called "Account Manager".Update a field in the ZOHO Form, basis numeric value in another field in the same form
I am trying to create a questionnaire in ZOHO, where clients need to answer 10 questions, and basis response, values are assigned. I have created a total score field where the sum of the values is stored. But i am unable to create a rule whereby anotherHow to update "Lead Status" to more than 100 records
Hello Zoho CRM, How do I update "Lead Status" to more than 100 records at once? To give you a background, these leads were uploaded or Imported at once but the lead status record was incorrectly chosen. So since there was a way to quickly add records in the system no matter how many they are, we are also wondering if there is a quicker way to update these records to the correct "Lead Status". I hope our concern makes sense and that there will be a fix for it. All the best, JonathanNext Page