Kaizen #189: Manipulating Multi-Module Lookup (MML) Field using Zoho CRM APIs

Hello everyone!

Welcome back to another week of Kaizen.

In this post, we explore the Multi-Module Lookup (MML) field in the Appointments module of Zoho CRM. You learn what an MML field is, how it works, and how to use it with Zoho CRM APIs.

Table of Contents:

• What is a Multi-Module Lookup (MML) Field in Zoho CRM?
• Use Cases for MML
  
• How  the "Appointment For" (MML) field in the "Appointments" module works?
• Creating a Record in the Appointments Module Using the Insert Records API
• Retrieving a Record from the Appointments Module Using the Get Records API
• Multi-module Lookup Using the COQL API
• Multi-module Lookup Using the Bulk Read API
• Frequently Asked Questions
  

What is a Multi-Module Lookup (MML) Field in Zoho CRM?

A Multi-Module Lookup (MML) field in Zoho CRM allows you to create a one-to-one relationship between a record in one module and a record from one of multiple other modules. Unlike a normal lookup field, which references a single module, an MML field can dynamically reference records from multiple modules. 

Without the MML field, users must create multiple lookup fields for each module, which complicates the CRM layout and user experience.

Note:

• The multi-module lookup (multi_module_lookup) data type was introduced in Zoho CRM API version 3.
• Currently, the MML field is available as a system-defined field named Appointment For in the Appointments module. 
• The Appointment For field supports lookups to both Contacts and custom modules.
• You cannot create a custom MML field in Zoho CRM.

Data Model Representation

MML's Data Model Representation

Use Cases for MML

Zylker Healthcare is a multi-specialty hospital that uses Zoho CRM to maintain its appointment scheduling process. 

In this setup, Zylker maintains two key modules:

• Contacts module - Stores records of physicians and surgeons, including attending physicians, specialists, and surgeons who diagnose and refer patients.
• Patients module - A custom module used to maintain records of all patients.

To improve the appointment booking process, Zylker uses the "Appointment For" Multi-Module Lookup (MML) field in the Appointments module. This field lets Zylker manage an appointment with either a Physician/Surgeon or a Patient, eliminating the need for multiple lookup fields.

How  the "Appointment For" (MML) field in the "Appointments" module works?

• When creating an appointment, the user selects the "Appointment For" field.
• The field displays records based on the selected module, either the Contacts or  Patients. 
• The user selects the appropriate record (Contact or Patients) for the appointment.
• A related list is automatically created in the selected module (Contact or Patients) as the Open Activities / Closed Activities to display all appointments associated with that record.
  

Creating a Record in the Appointments module using the Insert Records API

Before creating a record in the Appointments module via the Insert Records API, make sure you know the API names of the system-defined mandatory fields. These fields are required to create an appointment successfully.

System-defined Mandatory Fields:

• Appointment_For (MML field)
• Service_Name
• Appointment_Start_Time
• Appointment_Name
• Member
• Location

The below image shows how these system-defined mandatory fields appear in the Appointments module UI:

System-defined mandatory keys in the Appointments Module in UI view.

API calls you have to make before creating a record:

Before inserting a record into the Appointments module, it is important to know the API names of the fields and their parent modules. 

i. Use the GET - Module Metadata API to know the API name of the module. In our case, the Appointments module.

Request URL : {api-domain}/crm/v8/settings/modules

Request Method : GET

Sample Response :

 

In the API response, search for the module with "module_name": "Appointments" and check the value of the "api_name" key to get the API name of the module. This is the name you will use in all related API calls.

ii. Use the GET - Fields Metadata API and get fields metadata for the Appointments module. Here, you can find the API names of the mandatory fields along with other fields present in the Appointments module. 

Below is the API call & response for the multi-module lookup field along with other mandatory fields.

Request URL : {api-domain}/crm/v8/settings/fields?module=Appointments__s

Request Method : GET

Sample Response :

Note: The above image highlights only the key properties of the Multi-Module Lookup (MML) field from the field metadata response. The complete API response contains additional properties not shown here.

In the response:

• The multi-module lookup field is identified by the key "data_type" with the value "multi_module_lookup".
• The associated modules supported by the MML field (e.g., Contacts, Patients) are listed under the "modules" key.
• Other mandatory fields like Service Name, Appointment Name, and Appointment Start Time can be identified by "system_mandatory": true.
  

The keys of the above multi_module_lookup JSON object are explained below:

"multi_module_lookup": {     "display_label": "Appointments", // Display label of the module where the MML field is used     "api_name": "Appointments__s", // API name of the Appointments module     "modules": [ //List of modules associated with the Appointments module.          {             "api_name": "Contacts", //API name of the associated module              "module_name": "Contacts", // Display Name of the module              "id": "5725767000000002179" //Unique ID of the module         },         {             "api_name": "Patients", //API name of the associated custom module             "module_name": "Patients", //Display label of the module             "id": "5725767000006473007" //Unique module ID         }     } ] },

Note: 

• You cannot add or remove modules from the Multi-Module Lookup (MML) field using APIs. These actions are only available through the Zoho CRM UI.
• Once a module is disassociated from the MML field, existing records associated with that module will remain in the Appointments module, and you will no longer be able to associate newly created records from the disassociated module using the MML field. 
  

The remaining system-defined mandatory fields, along with their API names, are listed below.

System-defined Mandatory Field Names	System-defined Mandatory Field API Names
Service Name	Service_Name
Appointment Start Time	Appointment_Start_Time
Appointment Name	Appointment_Name
Member	Owner
Location	Location

Note: The system-defined mandatory fields can be identified by "system_mandatory": true.

Search the system-defined mandatory field names and get their API names.

With the field API names, use the following request and sample input body to create a record in the Appointments module using the Insert Records API.

Request URL : {{api-domain}}/crm/v8/Appointments__s

Request Method : POST

Request Body :

{     "data": [         {             "Appointment_Name": "General Consultation",             "Owner": {                 "name": "Patricia Boyle",                 "id": "5725767000000411001",                 "email": "patricia@zohotest.com"             },             "Appointment_Start_Time": "2025-04-15T13:00:00-07:00",             "Appointment_End_Time": "2025-04-15T13:30:00-07:00",             "Appointment_For": {                 "module": {                     "api_name": "Contacts",                     "id": "5725767000000002179"                 },                 "name": "John Doe",                 "id": "5725767000005607020"             },             "Service_Name": {                 "name": "General Check-up",                 "id": "5725767000006387029"             },             "Location": "Business Address"         }     ] }

Sample Response:

{     "data": [         {             "code": "SUCCESS",             "details": {                 "Modified_Time": "2025-05-06T20:33:42-07:00",                 "Modified_By": {                     "name": "Patricia Boyle",                     "id": "5725767000000411001"                 },                 "Created_Time": "2025-05-06T20:33:42-07:00",                 "id": "5725767000006390001", //Unique ID if the newly created record. Please note that this record ID will be used in the following API get and update operations.                 "Created_By": {                     "name": "Patricia Boyle",                     "id": "5725767000000411001"                 }             },             "message": "record added",             "status": "success"         }     ] }

Note:

Only Contacts and custom modules are supported in the Multi-Module Lookup field. If you try to associate a new record with a module that has been removed from the MML field or an unsupported module in the MML field, the following error will be thrown. 

Retrieving a Record from the Appointments Module Using the Get Records API

Request URL : {{api-domain}}/crm/v8/Appointments__s/5725767000006390001

Request Method: GET

Request Response:

{     "data": [         {             "Owner": {                 "name": "Patricia Boyle",                 "id": "5725767000000411001",                 "email": "patricia@zoho.com"             },             "$currency_symbol": "$",             "Address": null,             "Appointment_Start_Time": "2025-04-15T13:00:00-07:00",             "Cancellation_Reason": null,             "$field_states": null,             "Appointment_For": {                 "module": {                     "api_name": "Contacts",                     "id": "5725767000000002179"                 },                 "name": "John Doe",                 "id": "5725767000005607020"             },             "Rescheduled_To": null,             "$sharing_permission": "full_access",             "Reschedule_Reason": null,             "Additional_Information": null,             "Last_Activity_Time": null,             "Cancelled_Time": null,             "Cancellation_Note": null,             "Modified_By": {                 "name": "Patricia Boyle",                 "id": "5725767000000411001",                 "email": "patricia@zoho.com"             },             "Reschedule_Count": 0,             "Rescheduled_By": null,             "id": "5725767000006390001",             "Rescheduled_Time": null,             "Remind_At": null,             "Appointment_End_Time": "2025-04-15T13:30:00-07:00",             "Status": "Overdue",             "Modified_Time": "2025-05-06T20:04:38-07:00",             "Service_Name": {                 "name": "General Check-up",                 "id": "5725767000006387029"             },             "Created_Time": "2025-05-06T20:04:38-07:00",             "testing": null,             "Rescheduled_From": null,             "Cancelled_By": null,             "$editable": true,             "Appointment_Name": "General Consultation",             "Duration": 30,             "Record_Status__s": "Available",             "Created_By": {                 "name": "Patricia Boyle",                 "id": "5725767000000411001",                 "email": "patricia@zoho.com"             },             "Tag": [],             "Location": "Business Address",             "Reschedule_Note": null         }     ] }

Updating MML Field Value Using the Update Records API

Request URL : {{api-domain}}/crm/v8/Appointments__s/5725767000006390001

Request Method: PUT

Request Body:

{     "data": [         {             "Appointment_Start_Time": "2025-04-16T14:00:00-07:00", //Updating the Appointment_Start_Time             "Appointment_End_Time": "2025-04-16T14:30:00-07:00", //Updating the Appointment_End_Time             "Appointment_For": {                 "module": {                     "api_name": "Employees", //Updating a different module                     "id": "5725767000002161028"                 },                 "name": "Patrica", //A record from the Employees module                 "id": "5725767000006272001" //unique ID of the record             }         }     ] }

Multi-module Lookup Using the COQL API

Querying Inner Fields of Linked Modules within the MML Field

With the COQL API, you can query inner fields of linked modules within a Multi-Module Lookup (MML) field. This provides deeper insights into related fields data in a module. This query support is available from Zoho CRM API Version 7.

Sample Query:

{  "select_query": "select 'Appointment_For->Contacts.Lead_Source' from Appointments__s where id is not null" }

The above query retrieves the Lead Source field from the Contacts module within the Appointment_For MML field. 

Sample Response:

Querying Multi-Module Lookup Module Name

Querying the module name associated with each record in a Multi-Module Lookup (MML) field. This query support is available from Zoho CRM API Version 7.

Sample Query:

{ "select_query": "select Appointment_For.module.api_name, Appointment_For from Appointments__s where id is not null" }

The Appointment_For.module.api_name returns the module name (e.g., Contacts or Accounts) for each record linked in the Appointment_For MML field.

Sample Response:

Multi-module Lookup Using the Bulk Read API

Bulk Read API allows you to fetch a large set of data i.e., you can fetch a maximum of 2,00,000 records in a single API call. 

Specify the API name of the Appointments module in the module JSON object when making API calls. Refer to the following section for an example.

Request URL : https://www.zohoapis.com/crm/bulk/v8/read

Request Method : POST

Request Body :

{     "callback": {         "url": "https://webhook.site/7b58ff0b-b61b-4fbf-953f-1bf8b180a3c4",         "method": "post"     },     "query": {         "module": {             "api_name": "Appointments__s" //API name of the Appointments module         },         "file_type": "csv"     } }

Note: The Appointment_For field cannot be used in the criteria.

As the API is an asynchronous API, the response will not be available instantly; the bulk read job is scheduled, and the status can be checked. Once the job is completed, you will be notified in the callback URL. The records are available in a downloadable CSV file or ICS file (for events). See the Bulk Read API document to know how to view the status of the scheduled job and download the file, along with more sample requests and responses.

Sample Exported Response 

Frequently Asked Questions

1. Which modules are currently supported in the MML field?

Only Contacts and custom modules can be associated with an MML field.

2. What error is thrown if I try to associate a record with a removed or unsupported module in the MML field?

If you try to associate a record with a removed or unsupported module in an MML field, the system will throw an "INVALID_DATA" error.

3. Is the MML field available for all modules?

No, as of Zoho CRM API Version 8, the MML field is available only as a system-defined field in the Appointments module.

4. How do I get the list of modules associated with an MML field?

You can use the GET - Fields Metadata API for the Appointments module and look for the field with "data_type" : "multi_module_lookup" and check its "modules" JSON array.

5. Can I add or remove modules from a Multi-Module Lookup (MML) field via API?

Adding or removing modules in an MML field is not supported via API. These actions can only be done through the Zoho CRM UI.

6. What happens if I remove a module from an MML field?

If a module is removed from the MML through Zoho CRM UI, it can no longer be associated with new records, but existing records linked to that module will remain unaffected.

7. Is MML field supported in the Bulk Write API?

As of Zoho CRM API Version 8, the MML field is available only in the Appointments module as a system-defined field. The Appointments module is not supported in the Bulk Write API.

8. Is MML field supported in the Search API?

The MML field is not currently supported in the Search API.

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!

Cheers!!!

Previous Kaizen: Kaizen #188 - Building a Timer and Worklog Widget (Part 2)

Related Readings:

• Kaizen #124 - Manipulating Subform using Zoho CRM APIs
  
• Kaizen #125 Manipulating Multi-Select Lookup fields (MxN) using Zoho CRM APIs
  

• Topic Participants

• Subramanian K

  

• Andres

• 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 are

• 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 achieved

• 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.

• 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

• Recent Topics

• Automation Series: Auto-update Phase Status

  Hello Folks! You can auto-update your phase's status based on status of underlying tasks using custom functions. In this series, we will showcase how to create and run custom functions, using Deluge, with ease. Follow the steps below and automate your

• how to add subform over sigma in the CRM

  my new module don't have any subform available any way to add this from sigma or from the crm

• Zoho Projects - Project Details on the Project Menu

  Hi Project's team, I've helped may businesses setup and use Zoho Project and one thing I see time and time again is confusion on where to find the Project Details information. I would be much more intuitive if Project Details was on the menu before Dashboard.

• Zoho Projects - Add Feed to Project Tabs

  Hi Projects Team, I'm working on a lightweight communications requirement for one of my customers in relation to communicating with their client users via Zoho Projects. I noticed that the Feed is only available in the Collaboration section, but you can

• Flow - Fetch info from drop down in another module

  I am running into a road block which I thought would be a simple task. My goal - The account is assigned to a "route" which can be selected from a drop down menu and adds a tag to the account accordingly (easy enough). Now when I create a task for this

• Show unsubscribed contacts ?

  Hello, I would like to display the unsubscribed contacts. Unfortunately, I do not have this subscription type as described in the documentation (https://help.zoho.com/portal/en/kb/marketing-automation-2-0/user-guide/contacts/contact-management/articles/subscription-type-24-1-2024#Subscription_Type_field.)

• Zoho Developer Community Hackathon 2025 is LIVE!

  Hey developers! It’s that time of the year again — the Zoho Developer Community Hackathon 2025 is officially open for registrations! If you’ve been waiting for a chance to stretch your skills, try something new, or finally bring that idea to life, this

• Converted Leads Not Showing in Lead Reports

  Converted leads are not showing in the Lead reports. How can I make converted leads visible in the report,

• Text widgets in dashboards

  Having a text widget in a dashboard would help immensely. It would allow adding links to related documents, relevant CRM views, etc. It would allow adding explanations of the data displayed in the other widgets, about how to interpret them or about filtering.

• [Webinar] Zoho Writer for content creators and publishing houses

  Managing multiple drafts, edits, and client reviews doesn't have to slow you down. Join our upcoming webinar to see how Zoho Writer helps content creators and publishing houses create, edit, and publish seamlessly—all in one place. You'll learn how to:

• Adding Reports to Portals

  Is there a way to add Reports to portals so only the user can see report templates relevant to them?

• How to assign one Manual to multiple Spaces?

  Hello, I have two spaces, one called tech knowledge and the other one called HR knowledge. I have a manual that is called HR tech. I want to assign this manual to HR knowledge and tech knowledge. How should I do that?

• Introducing VeriFactu Support in Zoho Books

  Hello users, Spain has introduced the VeriFactu system under Real Decreto 1007/2023 to ensure integrity, traceability, and anti-fraud compliance in e-invoicing. Starting January 1, 2026, all B2B invoices must be reported to Agencia Estatal de Administración

• How can I assign courses to Spaces?

  How can I make courses show up here in this space?:

• When will Zoho Learn be able to support SCORM files on the mobile app?

  When I click the SCORM content, I just get a message saying it's not possible yet. Yet implies that it will be coming soon. All I'm asking for is a realistic timeline so I know whether or not to invest my time in using it. If it will be soon, then I will

• Announcing new features in Trident for Windows (v.1.35.6.0)

  Hello Community! Trident for Windows just got better with an update that makes working with your emails even more efficient. Let’s dive into what’s new! Work with PST files more efficiently. You can now do more than just view mounted PST files. You can

• Marketing Tip #9: Track your traffic sources

  Not all marketing channels work equally well. Knowing whether your visitors come from Google, Instagram, or email helps you focus on what actually drives sales. Try this today: Check your Zoho Commerce reports or connect Zoho PageSense to see your top

• Google Analytics import data inaccurate (as of October 11, 2025)

  We have Zoho Analytics connected to GA4 to import daily event data. This has been running without issue for a couple of years. However, a month ago we started noticing discrepancies. All data until October 10 lines up perfectly - October 11 onward is

• Zoho Recruit Slow and Freezing on all screens

  We have had an issue with Zoho Recruit for weeks being extremely slow and at times freezing.  We have 100 mega internet, and I went into each computer and updated the virtual memory so there is more available.  Also restarted all computers daily.  Still having the issues.  Almost unable to work.

• Prevent accidental duplicate entry of Customer Ordersome

  Zoho Support has confirmed that Zoho currently does not have any method (using Deluge, flow or any other method) to alert a user when a sales order has been entered twice using the same customer reference number (i.e. a duplicate). Most ERP platforms

• Zoho Books | Product updates | November 2025

  Hello users, We’ve rolled out new features and enhancements in Zoho Books. From translating email notification templates to the new transaction locking restrictions, explore the updates designed to enhance your bookkeeping experience. Making Tax Digital

• Insert Image into Notebook page

  Prior to today, I could add images to my notebook pages. Today when I tried to do this I got an error message that said something like, "There's been a problem on our end. Try again later." So, I've tried all the ways I know how, but I can't insert an

• 【開催報告】名古屋 ユーザー交流会 Vol.2 2025/11/21 Zoho Analytics / Inventory で実現する在庫の"未来予測"

  ユーザーの皆さま、こんにちは。コミュニティチームの中野です。 11/21(金)に名古屋 ユーザー交流会 を開催しました。 本投稿では、当日実施したセッションの様子及び投影資料をお届けします。 会場にて参加できなかった皆さまも、ぜひご参照ください。 （Zoho 社員セッションの登壇資料については、11/28(金)開催の東京回の開催報告で共有いたします） 今年2回目の開催となる名古屋 ユーザー交流会では、株式会社エンツナクリエイト 野末さんによる Zoho Analytics / Inventory

• Is there a way to automatically add Secondary Contacts (CCs) when creating a new ticket for specific customers?

  Some of our customers want multiple contacts to receive all notifications from our support team. Is there a way to automatically add secondary contacts to a ticket when our support team opens a new ticket and associates it with an account? This would

• Improved RingCentral Integration

  We’d like to request an enhancement to the current RingCentral integration with Zoho. RingCentral now automatically generates call transcripts and AI-based call summaries (AI Notes) for each call, which are extremely helpful for support and sales teams.

• Edit Pinned Comments in Zoho Desk

  It's great that private comments can now be pinned to the top of the ticket but what would be extremely helpful would be to allow for the pinned comment to be edited vs. having to find the comment in the ticket to edit it.

• Updating Secondary Contact (CCs)

  We use Zoho Forms to capture the user request and integrated with Zoho Desk to raise tickets. Active Microsoft login is captured in our Zoho forms and registered as Primary contact in Zoho desk ticket. We also an have an option to raise ticket on behalf

• blank page after login

  blank page after logging into my email account Thanks you

• WriterTh

  After every space Writer goes to capital letters mode in my Android tablet. The cap mode stays till the second letter is typed in the word then it comes to normal mode.

• Zoho writer unable to merge documents to PDF with basic fonts in Hebrew or fonts from my computer

  I created several forms that will be merged into PDF files through Zoho Writer and I am unable to receive the PDF in the basic fonts of the Hebrew language or in the fonts I have on my computer. The writer exports to PDF an exchange font that looks very

• I have already created some Bots, Commands, and Widgets in Cliq, but I am still not seeing the “Create Extension” option in my account. Could you please help me enable or access this option?

• Infinite loop of account verification

  Hi I can't do anything on my zoho account.  I always get this message Hi Sheriffo Ceesay As a security measure, you need to link your phone number with this account and verify it to proceed further. When ever I supply the details, it displays that the number is associated with another account. I don't have any other account on zoho so this is really annoying. 

• How we cut CRM updates from ~20 minutes down to 2, our real workflow

  Updating the Zoho CRM after every call used to be one of the biggest time sucks for our team. By the time you write your notes, clean them up, fill in the fields, and log everything properly… you’ve easily lost 15–20 minutes per call. We started experimenting

• Arattai App Features Update

  1. Offline Messaging & Sync Enable users to compose messages without internet and deliver them automatically via peer-to-peer methods (Bluetooth/WiFi Direct) when nearby users are available. This would be a game-changer for rural India with unreliable

• How to add Product Add-Ons, Mandatory Forms, and Auto-Save Address in Zoho Commerce

  Hi all, I need help setting up several behaviors in Zoho Commerce. I can’t find the correct configuration options, so I want to confirm whether these are supported or if there is a workaround. 1. Product-Specific Add-Ons (Example: GWB Subscription) When

• Zohomail

  Im trying to setup email address zoho

• PROBLEMA

  Salve, non riesco a inviare email, e mi esce una tabela errore temporaneo. come posso risolvere il problema ?

• Forever FREE Business Email with Zoho Mail

  Forever FREE Business Email with Zoho Mail: is it available?

• Weekly Tips : Make collaboration effortless with Whiteboard in Zoho Mail

  Working with your team often means switching between emails, notes, and other applications just to explain an idea. Maybe you are trying to sketch a layout, plan a workflow, or quickly brainstorm ideas—with text alone, things can get confusing. So how

• Formula field number of days between 2 dates

  Hi, I want to have a formula field which calculates the following: IF EndDate < TODAY and Oproep is true (this is a checkbox field) than EndDate - StartDate, otherwise TODAY - StartDate It should calculate the number of days How can I write this for

• Next Page