Kaizen #50 - Deals Metadata #API
Hello everyone!
Welcome back to another post in the Kaizen series!
This week, we will discuss the Metadata API for the Deals module and explain every key in the response.
What are metadata?
Metadata are the additional information about a record's data or a module. For instance, the metadata of the Deals module comprises details like related list properties, whether the module is visible to the current user, whether the module can be accessed via API, and so on.
You can fetch the metadata of a module through the Module Metadata API.
Request URL: {api-domain}/crm/v2/settings/modules/module_API_name
Request method: GET
Sample response
Now, let us see the details of every key in the response.
Key | Data Type | Description |
global_search_supported | Boolean | Represents whether the records of the module are searchable globally (along with other modules). |
kanban_view | Boolean | Represents if the current view of the module's records is Kanban. |
deletable | Boolean | Represents if the current user can delete records from the module. |
description | String | Represents the description of the module. |
creatable | Boolean | Represents if the current user can create records in the module. |
filter_status | Boolean | Represents if the current custom view has additional filters applied. |
inventory_template_supported | Boolean | Represents if the module supports the usage of the inventory module templates. |
modified_time | DateTime (ISO 8601) | The date and time (in the current user's time zone) at which the module's properties were last modified. |
plural_label | String | The plural label of the module's name. |
presence_sub_menu | Boolean | Represents if there is a sub-menu for the module. |
triggers_supported | Boolean | Represents if the module supports triggers from custom buttons, workflows, approval etc. |
id | String | The unique ID of the module. |
isBlueprintSupported | Boolean | Represents if the module can participate in the blueprint process. |
related_list_properties | JSON Object | Represents the fields and the order they have to be displayed in, when this module is a related list in any other module. |
$properties | JSON Array | Represents the properties that the records of this module hold when they are involved in processes like approval, review etc. You receive the values of the fields in this array when you fetch a record from this module. Refer to our earlier post on $properties for details. |
per_page | Integer | Represents the number of records that are displayed per page in the UI. |
visibility | Integer | Represents the visibility of the module to the current user. 1 - The module is visible 0 - The module is hidden -1 - The module is unavailable/hidden by the system itself due to the downgrading of the plan. |
convertable | Boolean | Represents if the module's records can be converted into another module's records. For example, a lead can be converted to a contact, account or deal. |
editable | Boolean | Represents if the current user can edit the records in this module. |
emailTemplate_support | Boolean | Represents if the module supports the usage of the email templates. |
profiles | JSON Array | Represent the name and ID of the profiles that have the permission to access this module. |
filter_supported | Boolean | Represents if the module supports custom filters besides the system-defined ones in a custom view. |
display_field | String | Represents the data of the field that must be populated when a field of this module is a lookup field in another. |
search_layout_fields | JSON Array | Represents the fields you receive in the response when you search for the records of this module. |
kanban_view_supported | Boolean | Represents if this module's records can be viewed in the kanban view. |
show_as_tab | Boolean | Represents if you can view this module as a tab in the UI. |
web_link | URL | Represents the link you specified while creating a web tab. |
sequence_number | Integer | Represents the position of this module on the list of tabs in the UI. |
singular_label | String | Represents the singular label of the module's name. |
viewable | Boolean | Represents if the current user can view the records of this module. |
api_supported | Boolean | Represents if you can perform CRUD operations on the records of the module through the APIs. |
api_name | String | Represents the API name of the module. |
quick_create | Boolean | Represents if you can create records in this module from the Quick Create page. |
modified_by | JSON Object | The name and ID of the user who last modified the properties of the module. |
generated_type | String | Represents if the module was created by default, as custom or linking module, as a web tab, or a subform. |
feeds_required | Boolean | Represents if the module is given in feeds preference in the Feeds page in Zoho CRM. |
scoring_supported | Boolean | Represents if the records of the module qualify for the scoring process, if there is one. |
webform_supported | Boolean | Represents if the records in the module can be created via web forms. |
arguments | JSON Array | Represents the arguments you pass while opening a web tab. |
module_name | String | The name of the module. |
business_card_field_limit | Integer | Represents the number of fields you can have in the business card details. Note: Business card details are displayed on the "Details View" page of a record. This is also the information shown when you hover over a lookup field. |
custom_view | JSON Object | Represents the details of the current custom view of the current user. |
parent_module | String | Represents the API name of the parent module of this module. For example, the parent module for Calls, Tasks, and Meetings is Activities. |
We hope you found this post useful. Please write to us at support@zohocrm.com if you have any questions, or let us know in the comment section.
Cheers!
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
Shylaja S
Sticky Posts
Kaizen #226: Using ZRC in Client Script
Hello everyone! Welcome to another week of Kaizen. In today's post, lets see what is ZRC (Zoho Request Client) and how we can use ZRC methods in Client Script to get inputs from a Salesperson and update the Lead status with a single button click. In thisKaizen #222 - Client Script Support for Notes Related List
Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore howKaizen #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 achieved
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
Issues with Zoho Sheet in Mac
I have downloaded the Zoho App from App Store but It is failing to Save As, Open & Download Operations. App StoreWeekly Sales Summary
Is it possible to generate a weekly report in Zoho Books to show -$$ amount of estimates generated -# of estimates generated by Salesperson -$$ amount of Sales Orders created -$$ amount of Invoices generatedCan I write a check in Zoho Books with no associated bill?
This currently does not seem possible, and I have a client that desperately needs this function if I am able to convert them with Quickbooks. Thank you in advance for your reply.OpenAPI Specs are just plain wrong
The provided yml files for generating the OpenAPI specs are absolutely riddled with errors and inconsistencies. From missing fields on the objects, to just incorrectly named resource objects. I'm having to go through and manually changing the spec toAbout Meetings (Events module)
I was working on an automation to cancel appointments in zoho flow , and in our case, we're using the Meetings module (which is called Events in API terms). But while working with it, I'm wondering what information I can display in the image where theCustom Footer – Zoho Writer Document
Hello everyone, I’m having an issue adding a custom footer in a Zoho Writer document. I would like to insert my company information (including a logo + address) in the footer. The problem is that when I add these elements, the main content of my pagesReport grouping
I have added a grouping in a report but it is not working how i had expected. I wanted to group a summary on a field named Size but when i add the grouping the report is still showing me each record and making a summary at the bottom of the report. WhatSocial Media Simplified with Zoho Social: Preview your Instagram grid before posting
For a platform like Instagram that relies on visual appeal, it's important that you plan your image and video content in a way that holds your audience's attention. Planning your grid ahead of time gives you the benefit of understanding how your postsVAT rates - exempt and out of scope
Good Evening, UK based company here. I am a bit confused in respect of setting up VAT rates for exempt goods and services; at present I am simply leaving the VAT rate blank in the transactions in order to prevent any VAT appearing in the VAT return. WhenHow to loop through Multiple Upload and Display Actual File Name
I have been reading the help on the File Upload Control and reviewed the Deluge help on files and I can not figure out how to loop through the uploaded files and do anything but get the automatically created file names. The code below will run but eachabou arattai
I want to use the Arattai app for business purposes, so please convert my account to a business account.I have my own invoice app, and I want to link it with the Arattai app for direct messaging.Overlapping Reports in Dashboards
It's rare, but occasionally it would be a good feature if I were able to overlap reports, either fully or partially in the Dashboards. Also, then having the ability to move objects to the front or rear, or make them transparent/translucent would be goodLooking back at Zoho Calendar in 2025
Hello Zoho Calendar Community, As we step into a brand-new year, we’d like to take a moment to thank you for being an active and valued part of the Zoho Calendar community. Your trust, feedback, and continued engagement motivate us to keep evolving andThere was an error while connecting to GSTN
I am trying to file GSTR1. Everything flows smoothly until I reach the final step of filing the return. After I enter the PAN and OTP for filing it raises the error "There was an error while connecting to GSTN"Zoho Books Extension: What Happens If Custom Fields Already Exist?
When developing Zoho Books extensions, what happens if the target Zoho Books organization already has a custom field with the same API name as one defined in the extension? I’m asking because we originally created an on-Books version of this functionality,Internal Server Error (500) When Attempting to View Banking Transactions
I am experiencing an Internal Server Error (500) when attempting to view transactions across all of my banking accounts. Despite multiple attempts to resolve this, I have received little more than runaround from support, and the issue remains unresolved.How do I add a blank line to the Organisation Address Format?
I'd like to have my VAT number, for example, shown prominently by having a clear gap between it and the address block above, but any blank lines in the address format get ignored in PDF outputs.Automatic Invoice Number generation for createRecord
Hello, while testing some custom Buttons in my Zoho Books application, I noticed that I get an error that previously did not occur. After some further digging I found that the automatic transaction numbering of invoices no longer work in my organization.Adding number of days to an estimate.
I need both QTY of item and "number of days hire" in my estimates at the line item level. Any clues as to how this is done would be greatly appreciated. It needs to calculate. Thanks JBooks Api: listing expenses created after certain dates
Is there any parameter I can add to the List Expenses endpoint that will let me look up expenses by when they were created?Why can't we change the Account type from an Expense to an Asset?
Like the question. Why in QuickBooks for example if I mistakenly created an account as an expenses and I already captured information in those accounts, I can just change the account type from expense to assetNueva edición de "Ask The Expert" en Español Zoho Community
¡Hola Comunidad! ¿Te gustaría obtener respuestas en directo sobre Zoho CRM, Zoho Desk u otra solución dentro de nuestro paquete de CX (Experiencia del Cliente? Uno de nuestros expertos estará disponible para responder a todas tus preguntas durante nuestraIs it possible to do validation for the Actions added to Reports?
We have an all-around On Validate function that checks all the possibilities before the Created/Edited form submissions. We want to have a button in the report view, so we can change records without entering. We are able to add this button, and it doesAbility to Edit Ticket Subject when Splitting a Ticket
Often someone will make an additional or new request within an existing ticket that requires we split the ticket. The annoying part is that the new ticket maintains the subject of the original ticket after the split so when the new ticket email notification[Free Webinar] Environments in Zoho Creator - Creator Tech Connect
Hello Everyone, We’re delighted to kick off the 2026 edition of the Zoho Creator Tech Connect Series and are excited to continue this learning journey with you. The Creator Tech Connect series is a free monthly webinar featuring deep-dive technical sessionsZoho Voice API SMS
I made a post request in Zapier to try to send an SMS. Authentication appears to be configured correctly. I followed the documentation and I'm getting a 400 Error "Internal Server Error". Not helpful at all. Anyways, I could not find any information onHow do I change (error) display messages
Hi! I would like to edit display messages like "invalid entries" and "enter a value for Nome" and so on into Italian language messages. How can I do that? Already tried on Validate on form submit. Where I am failing? Thanks in advance.Record Overseas Transactions Along with CC charges
Hi All, We receive payments via stripe in multiple currencies and stripe takes around 2.5% fees. The amount is settled in INR into our local bank. What should be the currency of the income account used for Stripe payments? Here is a sample flow that weEasier onboarding for new users with stage descriptions
Greetings, I hope all of you are doing well. We're happy to announce a recent enhancement we've made to Bigin. You can now add descriptions to the stages in your pipeline. Previously, when creating a pipeline, you could only add stages. With this update,Pieds de page personnalisé - Document Zoho Writer
Bonjour à tous, Je rencontre un souci avec l’ajout d’un pied de page personnalisé dans un document Zoho Writer. Je souhaite insérer les informations de mon entreprise (notamment un logo + adresse) dans le pied de page. Le problème, c’est que lorsque j’ajoutePermissions on Views
Having the option of any agent creating custom views is firing back and got a situation where there are a hundred different views across the team and tickets are not being dealt in the most efficient of ways. Tickets seems to be missed by some agents,Credit card transactions are backwards after importing statements
I am new to Zoho Books so I'm importing my firm's bank and credit card statements in. My credit card statements have a single column with negative numbers so that is the option I chose. But when I went to categorize the credit card transactions, I canimport data from Apollo.ai into zoho crm via zoho flow
I might be asking this question in the wrong forum. We use Apollo.ai to find potential new leads for our business, there are around 10000 leads that we have initially found. We have an Apollo.ai account but just to do searches, we dont use it as a crm.Knowledgebase SEO
We have a custom-domain mapped help center that is not restricted via login. I have some questions: a) will a robots.txt file still allow us to control indexing? b) do we have the ability to edit the sitemap? c) do category URLs get indexed by searchVIsual maindmaps in Zoho notebook Ai
Can I create and export VIsual maindmaps in Zoho notebook Ai1stDibs Integration to Zoho Inventory
Hello is it possible to integrate my Zoho inventory and 1stDibs?Community Question: Renewal vs Invoicing
This is a question for the community. Does anyone else consider there to be a difference between a subscription renewal event and sending out a recurring invoice for a subscription? For example, let's say customer XYZ purchases a 1-year subscription tocloud console support for music websites
Hi Friends, I am not from a very technical background.. So need support from the Zoho family. I want to build a e-commerce website which is in Musical Niche. It will help people learn music & play instruments of all types. There are a few players in the market like Chordify , Guitaa, Guitar Dashboard, ChordU & few others. But I all these websites allow only a few instruments to play. So I want to build a better website than the one I mentioned. So wnated to know what UI & AI should I use so thatScheduled Reports - Do not send empty report
Hello, We are intensively using reports in the CRM, especially for sales managers. When data is empty, they still receive an email. Can you add an option to avoid sending the report when data is empty?Is Zoho One Desktop more secure than Zoho One Web SaaS?
Is Zoho One Desktop more secure than using Zoho One in browser? Inherently, it seems desktop would be unless you don't do things like share your pw or leave pc on. I am concerned about data being on the cloud or someone else's server and database.Next Page