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 #217 - Actions APIs : Tasks
Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.Kaizen #216 - Actions APIs : Email Notifications
Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes areKaizen #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 the
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
Marketer's Space: Why mobile optimization deserves a place in your email strategy
Hello Marketers, Welcome back to Marketer's Space! Today, we'll talk about the importance of creating mobile-friendly email designs. While mobile phones were once used only to make phone calls, today they're used for almost everything, including texting,Why is Zoho Meeting quality so poor?
I've just moved from Office 365 to Zoho Workplace and have been generally really positive about the new platform -- nicely integrated, nice GUI, good and easy-to-understand control and customisation, and at a reasonable price. However, what is going onCollections Management: #6 Realign Customers who gets back In-Term
Arun stared at the subscription list on his dashboard. Another account had just been moved to Cancelled status after completing the whole dunning process. Nothing unusual, just that payment failures happen, retries fail, and cancellation is the expectedEnhancement Request for Multi-Asset Work Order Feature
Hello Latha, Thank you for your continued support. The multi-asset Work Order feature is extremely helpful. I did some testing based on our requirements, and during the process, I noticed a few areas where we need your team’s support to improve the featureZoho Mail IP Blacklist
I need problems with send mails: Error: junk mail rejected - sender4-op-o10.zoho.com 136.143.188.10, is in RBL. Spamcop. Please remove FQDN for blacklist. Regards.I can receive but not send emails
Hello, I've been not able to send emails for almost a year now. I been using alternate email to do this. I want to know how to fix this so I can use my zoho account normally again.Setting checkbox value on template in Sign from Creator
Good day, Please help me understand how do I set a tick from a checkbox in Creator into a checkbox on a Sign template. Below is the only values on the Sign template and the code from Creator, "field_boolean_data": {}, "field_date_data": {}, "field_radio_data":The challenge of 24/7 connectivity: Being present and meeting customer expectations
Before television entered our homes, radio was our window to the world. We had to tune carefully to catch voices from distant places. When television arrived, the world began to grow smaller. We can watch rocket launches, see the goal that wins our favoriteHow to download all attachments from inbox, send, other folders in one go
Hi All, Appreciate if anyone could help me with steps for below requirement. How to download all attachments from inbox, send, other folders in one go. Even mapping to new folder will help me. Thanks in advance.Recruit paid support?
Hi all, Could anyone who has paid support package advise if it provides value for money with regards to support response times? Exploring the idea as unfortunately when we have faced issues with Recruit it has been a 7+ day timescale from reporting toCannot connect mail accounts to Thunderbird
Hi Support - I'm attempting to add my mail accounts to Thunderbird but I'm getting an unable to login to server error. I tried to use the password associated with my account I received the unable to login error. So I went into Zoho Accounts and generateAlias Email Id already exists
Hi, I just verified my domain sesque (dot) com and now I am trying to create the admin account using admin (at) sesque (dot) com, but I am getting an error saying "Alias Email Id already exists". I used to have another Zoho account with this email address,Unable to connect to smtp server, connection timed out
Hi Team, I am facing below issue, while sending out emails from thunderbird client. It used to work, facing this issue from morning. Error: Sending of the message failed. The message could not be sent because the connection to Outgoing server (SMTP) smtp.zoho.comjavax.mail.authenticationfailedexception 535 authentication failed
Hi, I am facing 535 authentication failed error when trying to send email from zoho desktop as well as in webmail. Can you suggest to fix this issue,. Regards, RekhaIssue with Creator's IF logic
Hi, I found the following code produces unexpected results: if(-1.0 < 0.0000000) { info "True"; } else { info "False"; } if(-1.0 < 0.000000) { info "True"; } else { info "False"; } The output returned is: False True However, theKaizen #217 - Actions APIs : Tasks
Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.Client Portal ZOHO ONE
Dear Zoho one is fantastic option for companies but it seems to me that it is still an aggregation of aps let me explain I have zoho books with client portal so client access their invoice then I have zoho project with client portal so they can access their project but not their invoice without another URL another LOGIN Are you planning in creating a beautiful UI portal for client so we can control access to client in one location to multiple aps at least unify project and invoice aps that wouldZoho Creator customer portal users
Hi, I'm in a Zoho One subscription with our company. I'm running a project now that involves creating a Zoho Creater application and using the Zoho Creator Customer Portal. At most we need 25 customer portal users. In our Zoho One plan we only get 3DKIM Verification Failed (Namecheap)
Hi! I have already set up the TXT records in Namecheap but I keep getting the "Verification Failed" pop up. Was wondering if I'm the only one who has this problem and can anyone help me with this? Thanks!Emails stuck in Queue
Hi there, Since yesterday I have a few out going emails stuck in a queue. It say it will auto retry sending however nothing is happening. It seems to be affecting roughly 50% of my outgoing emails. Please help ThanksSoft Bounce from transational emails from BREVO (Sendinblue)
I manage the website of a client who uses your EMAIL service for the domain floranativadobrasil.com. And I use the BREVO email service, previously called SendinBlue, to send transactional emails about events specific to the website. All emails sent toAbility to Edit YouTube Video Title, Description & Thumbnail After Publishing
Hi Zoho Social Team, How are you? We would like to request an enhancement to Zoho Social that enables users to edit YouTube video details after the video has already been published. Your team confirmed that while Zoho Social currently allows editing theIntroducing Multi-Asset Support in Work Orders, Estimates, and Service Appointments
We’re excited to announce a highly requested enhancement in Zoho FSM — you can now associate multiple assets with Work Orders, Estimates, and Service Appointments. This update brings more clarity, flexibility, and control to your field service operations,Getting an error Address not found Your message wasn't delivered
Hey, I'm trying to configure zoho mail for my website https://businessentity.org/ The email is meredith.karter@businessentity.org I'm able to successfully send the mails but when someone sends an email to above mail, this error shoots up: Address notSupport Uploading YouTube Videos Longer Than 60 Minutes
Hi Zoho Social Team, How are you? We would like to request support for uploading YouTube videos longer than 60 minutes directly through Zoho Social. Your support team informed us that Zoho Social currently cannot upload videos over 60 minutes due to “APINeed Faster Help? Try Live Chat Support
Hello there, We understand that sometimes, whether you’re facing an issue, exploring a feature, or need quick clarification, sending an email and waiting for a response just doesn’t cut it. You need answers, and you need them now. That’s exactly why weCan't deactivate Spell Check
Hi Community, right now I'm using the Zoho Mail Desktop-Software. So far, so good.. many possibilities. Overall very nice. What is extremely annoying right now, is that we are not able to deactivate the Spell Check feature. And we are barely able to focusZoho Toolkit Email Signature Generator
I'm having real issues with the email signature generator with no matter where I host the photo, Zoho doesn't seem to show the photo on the link provided?Company Policy Upload - Request All EE to review and sign
How can I upload policies into Zoho People and have the employees review them and sign off saying they agree, etc.? Also, if I make a revision to a policy, I would like that changed or updated policy to be distributed or have the employees notified thatZoho Sign Global Settings vs. Template and Document
Hello, We are running into an issue on a current use case. We already use Zoho Sign. Now that KBA is available, we want to begin using it in our tax delivery process, by allowing clients to sign electronically, but also download a copy of their returnZoho Mail Desktop Crashes on Linux - Ubuntu 24 LTS
Hi, I have been trying to run the desktop app on Ubuntu for the past few day with no luck. I have tried both the .deb package and the appImage. When I attempt to open the app. It just crashes immediately. The crash error dialog appeared once and I cantCan't login to Zoho mail
I'm logged into Zoho but when I try to go in zoho mail I get: Invalid request! The input passed is invalid or the URL is invoked without valid parameters. Please check your input and try again. I just set up my mx records and stuff with namecheap a fewZoho IP blocked by SpamCop
Hi, Many of my emails are blocked and I receive this: INVALID_ADDRESS, ERROR_CODE :550, ERROR_CODE :spamcop.mimecast.org Blocked - see https://www.spamcop.net/bl.shtml?136.143.188.51. - https://community.mimecast.com/docs/DOC-1369#550 [DGwIYPPSOfWICan I execute two 'functions' when completing a mail merge from CRM?
Hi, I have set up a mail merge from CRM Deals to a template. I want a copy of this to be saved in Workdrive, and then a copy also saved back into the deal record from which the merge occurred. I can do both independent of each other, and managed to getDifferences between Zoho Books and Zoho Billing
Without a long drawn out process to compare these. If you were looking at these Books and Billing, what made you opt for one and not the other. ThanksAuto-sync field of lookup value
This feature has been requested many times in the discussion Field of Lookup Announcement and this post aims to track it separately. At the moment the value of a 'field of lookup' is a snapshot but once the parent lookup field is updated the values diverge.Custom validation in CRM schema
Validation rules in CRM layouts work nicely, good docs by @Kiran Karthik P https://help.zoho.com/portal/en/kb/crm/customize-crm-account/validation-rules/articles/create-validation-rules I'd prefer validating data input 'closer to the schema'No Ability to Rename Record Template PDFs in SendMail Task
As highlighted previously in this post, we still have to deal with the limitation of not being able to rename a record template when sent as a PDF using the SendMail Task. This creates unnecessary complexity for what should be a simple operation, andServer error when trying to Data > Sort > Custom Sort
Been using Data > Sort > Custom Sort for a while, now it has suddenly stopped working. When selecting the same data range and trying to execute, I get "Sorry! There was a problem saving your last edit. Please try again."To Assign a genrated pdf to a file upload field using delug
content = "<html><body>HTML Content on page One <div style='page-break-after:always'></div> HTML Content on page Two </body></html>"; file = zoho.file.convertToPDF(content); file.setFileName("Name of the file"); <variableName> = <FormLinkName>[ID == input.ID];Next Page