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

Zoho Developer Community

New to Zoho LandingPage?

Access Zoho LandingPage

Zoho LandingPage Resources

New to Zoho Survey?

Access Zoho Survey

Latest Feature Updates

Explore our Pricing & Plans

Zoho Survey Resources

Android Mobile Surveys

Insurvey Blogs

Insight Blogs

Tips & Tricks

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Bigin?

Signup Now

Access Bigin

Latest Feature Updates

Zoho Desk Resources

Desk Community Learning Series
Digest
Functions
Meetups
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner
Word of the Day

Tout forum

France ZUGs

Zoho SalesIQ Resources

Topic Participants
Shylaja S

Sticky Posts
Kaizen#162 : Add Tags and Open Pre-filled Email Drafts via Client Scripts
Hello everyone! Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script. 1. How to auto-tag a record based on field update? 2. How to Open a pre-filled email draft This post will provide
Client Script | Update - Introducing Commands in Client Script!
Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! Commands
Extension Pointers - JS SDK series #4: Managing data from a widget using ZOHO.CRM.HTTP
Handling and managing the data between two applications is a major factor for an efficient business. There are a variety of ways to handle data between Zoho CRM and other third-party applications. You can use deluge CRM tasks, create connectors, use API
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
Extension pointers for integrating Zoho CRM with Zoho products #8: Upload and manage Zoho Workdrive folders and files from within Zoho CRM
Keeping records on your customers and business prospects is essential for tracking data, conducting follow-ups, and running a business smoothly. When you use two separate applications, and store relevant data in each, checking and tracking data becomes