Kaizen #40 - System-defined fields and their default values in Leads #API
Hello everyone!
Welcome back to another post in the Kaizen series!
This week, we will discuss the system-defined fields and their default values in the Leads module in Zoho CRM.
We will cover the following in this post:
- System-defined non-mandatory fields and their default values
- System-defined mandatory fields
What are the system-defined fields in a module?
The fields that are available by default in a module, are system-defined fields. You can choose to set values to these fields, or the system assigns the default value for applicable fields.
How can you find which fields are system-defined?
Use the Fields Metadata API. The response contains all the fields available in that module for your org.
The boolean value of the key custom_field indicates whether the field is system-defined or a custom field in that module. The value "true" indicates that the current field is a custom field, and the value "false" indicates that the current field is a system-defined field.
System-defined mandatory fields
Few system-defined fields are mandatory. If left unspecified, the system throws the MANDATORY_NOT_FOUND error.
The boolean value of the key system_mandatory indicates whether the field is mandatory in that module. The value "true" indicates that the current field is a system-defined mandatory field, and the value "false" indicates that the current field is not a system-defined mandatory field.
Note
We cannot modify the properties of a few system-defined fields. Ex: Last_Name in Leads.
Fields Metadata API for the Leads Module
Sample Request
Request URL: {{api-domain}}/crm/v2/settings/fields?module=Leads
Request Method: GET
Sample Response
{ "fields": [ { "system_mandatory": false, "webhook": true, "json_type": "jsonobject", "crypt": null, "field_label": "Lead Owner", "tooltip": null, "created_source": "default", "field_read_only": true, "display_label": "Lead Owner", "read_only": false, "association_details": null, "businesscard_supported": true, "multi_module_lookup": {}, "currency": {}, "id": "949200000000000553", "custom_field": false, "lookup": {}, "visible": true, "length": 120, "view_type": { "view": true, "edit": true, "quick_create": false, "create": true }, "subform": null, "api_name": "Owner", "unique": {}, "data_type": "ownerlookup", "formula": {}, "decimal_place": null, "mass_update": false, "multiselectlookup": {}, "pick_list_values": [], "auto_number": {} }, { "system_mandatory": false, "webhook": true, "json_type": "string", "crypt": null, "field_label": "Company", "tooltip": null, "created_source": "default", "field_read_only": false, "display_label": "Company", "read_only": false, "association_details": null, "quick_sequence_number": "1", "businesscard_supported": false, "multi_module_lookup": {}, "currency": {}, "id": "949200000000000555", "custom_field": false, "lookup": {}, "visible": true, "length": 100, "view_type": { "view": true, "edit": true, "quick_create": true, "create": true }, "subform": null, "api_name": "Company", "unique": {}, "data_type": "text", "formula": {}, "decimal_place": null, "mass_update": true, "multiselectlookup": {}, "pick_list_values": [], "auto_number": {} }, { "system_mandatory": true, "webhook": true, "json_type": "string", "crypt": null, "field_label": "Last Name", "tooltip": null, "created_source": "default", "field_read_only": false, "display_label": "Last Name", "read_only": false, "association_details": null, "quick_sequence_number": "3", "businesscard_supported": false, "multi_module_lookup": {}, "currency": {}, "id": "949200000000000559", "custom_field": false, "lookup": {}, "visible": true, "length": 80, "view_type": { "view": false, "edit": true, "quick_create": true, "create": true }, "subform": null, "api_name": "Last_Name", "unique": {}, "data_type": "text", "formula": {}, "decimal_place": null, "mass_update": false, "multiselectlookup": {}, "pick_list_values": [], "auto_number": {} }, { "system_mandatory": false, "private": null, "webhook": true, "json_type": "jsonobject", "crypt": null, "field_label": "Related Users", "tooltip": null, "created_source": "default", "field_read_only": false, "display_label": "User", "read_only": false, "association_details": null, "businesscard_supported": false, "multi_module_lookup": {}, "currency": {}, "id": "4150868000000625001", "custom_field": true, "lookup": {}, "visible": true, "length": 50, "view_type": { "view": true, "edit": true, "quick_create": false, "create": true }, "subform": null, "api_name": "User", "unique": {}, "data_type": "userlookup", "formula": {}, "decimal_place": null, "mass_update": false, "multiselectlookup": {}, "pick_list_values": [], "auto_number": {} }, ... ] } |
System-defined non-mandatory fields and their default values
The following table gives the list of all the system-defined non-mandatory fields in the Standard Layout of the Leads module.
Field API Name | JSON Type | CRM Data Type | Default Value |
Owner | JSON Object | Lookup | Name and ID of the current user |
Company | String | Single Line | null |
First_Name | String | Single Line | null |
Salutation | String | Picklist | None |
Email | String | Email | null |
Full_Name | String | -- | null |
Phone | String | Phone | null |
Mobile | String | Phone | null |
Designation | String | Text | null |
Lead_Status | String | Picklist | null |
Fax | String | Phone | null |
Website | String | URL | null |
Lead_Source | String | Picklist | null |
No_of_Employees | Integer | Number | null |
Industry_Type | String | Picklist | null |
Rating | String | Picklist | None |
Tag | JSON Array | -- | null |
Annual_Revenue | Double | Currency | null |
Created_By (not editable) | JSON Object | -- | Name and ID of the current user |
Email_Opt_Out | Boolean | Checkbox | false |
Skype_ID | String | Single Line | null |
Modified_By (not editable) | JSON Object | -- | Name and ID of the user who last modified the record last |
Created_Time (not editable) | String | -- | The date and time at which the record was created |
Secondary_Email | String | Email | null |
Modified_Time (not editable) | String | -- | The date and time at which the record was last modified |
Twitter | String | Single Line | null |
Last_Activity_Time (not editable) | String | -- | The date and time at which the record was used last |
Converted_Date_Time | String | -- | The date and time at which the lead or quote was converted |
Street, City, State, Zip_Code, Country | String | Single Line | null |
Description | String | Multi-line | null |
Record_Image | String | -- | null |
You can refer to the Sample Attributes section of our Insert Records API for an example on adding values to the above fields.
System-defined mandatory field for the Leads module:
Field API Name | JSON Type | CRM Data Type | Default Value |
Last_Name | String | Single Line | Not applicable |
Note
- In the Fields Metadata API, the value true for the key "field_read_only" indicates that it is read-only always.
- The value true for the key "read_only" indicates that the key is read-only for the viewing user's profile. You can set the properties of such fields based on the profile. A user without the desired profile cannot edit these fields through an API.
- You cannot modify the properties of system-defined mandatory fields in any module.
- You can choose to alter the properties of the system-defined(non-mandatory) or custom fields in standard/custom layouts. The details of all the fields in all the layouts will be retrieved in the fields metadata API response.
- You can also choose to set default values for fields with CRM field types—picklist, multi-select picklist, and checkbox.
We hope you found this post useful. Write to us at support@zohocrm.com if you have any questions, or let us know in the comment section.
Cheers!
Previous 'Kaizen' - Deals #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
Sneha Sridharan
Jeremy Nagel - www.smooth.tel
Kevin Flynn
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
Tip #47- Stay Ahead with Automated Scheduled Reports in Zoho Assist- 'Insider Insights'
We’ve made it easier for you to stay informed, even when you’re busy managing remote sessions! With Scheduled Reports in Zoho Assist, you can now automatically receive detailed insights about your remote support and unattended access activities directlyColour Coded Flags in Tasks Module List View
I really like the colour coded flags indicating the status of the tasks assigned to a Contact/Deal in the module list view. It would be a great addition to have this feature available in the list view of activities/tasks. I understand you have the DueUploading data to S3
Has anyone successfully uploaded data from Creator to S3 using the InvokeURL command or any other method in Deluge? (keywords: S3, AWS, Amazon, bucket)UPS Label size when generated via Zoho
We've integrated UPS with Zoho inventory. When creating and downloading the shipping labels they are created in a larger paper size. I'd like them to be generated to print on a 4x6 printer. Zoho have told me I need to do this within our UPS portal. UPSCredit Management: #4 Credits on Unused Period
Recall a familiar situation. You sign up for a monthly gym membership. You pay the subscription fee upfront, get motivated, and show up consistently for the first week. Then, suddenly, you get caught up in work deadlines, travel plans, or a dip in motivation.Zoho Analytics Automatically Deletes Queries and Reports When a Synced CRM Field Is Removed
We’ve encountered a serious and recurring issue that poses a massive data integrity risk for any Zoho Analytics customer using Zoho CRM integration. When a field is deleted in Zoho CRM — even an unused one — Zoho Analytics automatically deletes everyPrevent new Record Association
Hello all, We have a small sales organization therefore, it's helpful for everyone on the sales team to be able to view the full list of accounts to assist in preventing duplicate accounts from being created. However we want to prevent people from creatingTip of the Week #73– Automate workflow with Make integration.
Make is a no-code workflow automation platform designed to connect your favorite apps and automate repetitive tasks across services. By integrating Make with Zoho TeamInbox, you can streamline everyday inbox management and save valuable time. With thisViewing attachments
I'm using a Web Form integrated in my web site to collect Leads several info, including a image upload. In order to to approve each lead, we have to view the image uploaded. Unfortunately, in the Leads view, the Attachments can only be downloaded, notKaizen #89 - Color Coding using Client Script
Hello everyone! Welcome back to another exciting Kaizen post. Today let us see how you can apply color codes to the List and Detail Pages of Zoho CRM using Client Script. Need for color code in Zoho CRM When you mark things with different colors as aInstant Sync of Zoho CRM Data?
With how valuable Zoho Analytics is to actually creating data driven dashboards/reports, we are surprised that there is no instant or near instant sync between Zoho CRM and Zoho Analytics. Waiting 3 hours is okay for most of our reports, but there areIs it possibly to directly set the tax amount on order instead of indirectly via tax rates?
We own an eCommerce application and want to funnel submitted orders from that system into Zoho. We're already calculating tax in our application and just need a way to set it in Zoho. We tried to use Zoho's tax objects for tax by setting the rates toZoho account sign in with passkey
Hello, I am trying to sign in using passkey, but the option doesn't show up in the web and is disabled in Oneauth on mobile, saying the admin has restricted the use. On the Admin page in Security MFA I can find no option for passkey. Help would be greatlyRescheduled US meetups: Zoho Desk user meetups are coming to seven U.S. cities in October and November, 2025
Hello to our Zoho Desk users in the United States, We're excited to share the revised dates for the upcoming Zoho User Groups happening across the US this summer. Our product experts are heading to seven cities throughout the country, and for the firstChecklists as templates
Is it possible to save checklists as templates to reuse them in other tasks? Example: I have a web project. I maintain individual web URLs as tasks. Within the tasks the same checklist should be used again and again: - Page created in CMS - PropertiesSend mass email using my secondary email
Hello, When I send an email to just one person from Zoho CRM, a complete email editor appears, where I can choose which of my email addresses I want to use in the From field. When I send a mass email, there is not such option. I can only select the emailZOHO TEAM INBOX Calendar Integration
The Problem: Clients send meeting invitations to our TeamInbox address. TeamInbox receives these invites, but we cannot accept them. We do not use individual inboxes for transparency purposes. Ideal Solution: A way to accept calendar invites sent to ourUnearned / Deferred Revenue Automatic Calculation for Subscriptions
As a SaaS business, we have multiple active subscriptions with varying dates and amounts. Is there a way to have a monthly automatic calculation for all of them that debits or credits the unearned revenue and revenue accounts accordingly? Alternatively,Zoho Desk Limit for Comma Separated Queries
Hi, I have just discovered a limit that I believed is not mentioned in any of Zoho's documentations. My search query looks like so: "query: {"accountId":"786050000091629966,786050000163589273,786050000163589427,786050000162753705,786050000162112971,786050000161987643,786050000160752868,786050000167089504,786050000167089378,786050000167089024,786050000167070005,786050000166295256,786050000128153693,786050000110560021,786050000046594575,786050000039106461,786050000002225356,786050000076889093,786050000047895103,786050000043365354,786050000044765191,786050000041790249,786050000040359116,786050000037945198,786050000024605077,786050000000525015,786050000155333895,786050000157741437,786050000000718125,786050000011574353,","departmentId":"786050000042648070","status":"Finished","sortBy":"createdTime","customField2":"cf_completion_date:2025-01-28T03:00:00.000Z,2025-10-28T03:00:00.000Z","customField3":"cf_billed:false"}"Module Name doesn't exist
I am trying to create a module named Activity, with plural Activities, but I have an error that module name already exists. This module is doesn't exist, and I don't have a single field called Activity or Activities.Zoho Desk iOS and Android app update: AI powered: Reply Assistance and Refine Messages on IM module.
Hello everyone! We are excited to introduce new AI powered features on the IM module of the Zoho Desk app. Reply Assistance: Reply Assistance generates suggested responses for incoming chat messages, which you can directly insert into the conversationUnify All Zoho Video Meeting Experiences into One Standardized Platform
Hi Zoho Team, We would like to share an important user experience concern regarding the current state of video meeting functionality across the Zoho ecosystem. The Problem Within Zoho, there are multiple ways to initiate or schedule a video meeting: ZohoIs it possible to embed Youtube shorts?
Hi Zoho desk support, This is Ryan from Accuver America. While I'm trying to create a knowledge base article with embed video, I ran into this issue. "www.youtube.com refuse to connect" A little bit background is that because this video is recorded onZoho Inventory - Move Orders
Quick question about Move Orders... Why is there no status to say something like "Draft", "In Progress" and "Completed", similar to Transfer Orders? I'm assuming that when something needs to be moved it should be planned in Inventory, executed and thenSplit functionality - Admins need ability to do this
Admins should be able to split an expense at any point of the process prior to approval. The split is very helpful for our account coding, but to have to go back to a user and ask them to split an invoice that they simply want paid is a bit of an inDelegates - Access to approved reports
We realized that delegates do not have access to reports after they are approved. Many users ask questions of their delegates about past expense reports and the delegates can't see this information. Please allow delegates see all expense report activity,How to include total km for multiple trips in expense report.
Whenever I create a mileage report it only shows the total dollar amount to be reimbursed. The mileage for each individual trip is included but I also need to see the total distance for all trips in a report? How do I do this?Get logged in user ID in Deluge script
Hello all, How do I get the id of the logged-in user in a deluge script? the "zoho.loginuserid" function actually returns the users email address or whatever the user id they use to login to zoho with and not the id of the user record, and given thatItem Details Field - New Barcode / Document option?
Is this a new feature??? its in both books and inventory.Shared Mailbox - Mark as read for all users
Hi all, Maybe someone can help me out. At the moment we have a shared mailbox without streams. When a users reads an mail or marks it as read other users will not see this. How can we resolve this? We now archive the mails when read and followed up. HoweverHow do I increase the email attachment size in Zoho CRM ?
It looks like I'm limited to 10MB when sending an attachment using the email widget on a record in Zoho CRM. Is there a way to increase the size? Or can I use some other tool? From what I'm reading online, I'm maxed out at 10MB. Any insight would be greatlyCan I export to PDF in Zoho Learn
I have seen help pages where export to pdf options are available but I do not see that option available from the application. I see that exprt is available in my free trial version but that is only to html pages. I need to be able to export my manualsZoho Sites "pages" management page
I have 80 plus pages on zoho sites. When I go to the "pages" link to view and edit pages, They are not in any kind of order, so I spend lots of time searching for pages when I need to edit or create new. How can I change the view order of all my pagesStaff rules
Hi! Do you people know what are the default staff rules when a new booking is created? We have two staff members in my team (me as the admin, and my employee). As we share the same services, I'm wondering how Zoho will pick the staff for new apointments.Add Image Upload Field to Zoho Bookings Registration Form
Hi, We would like to request the addition of an image upload field to the Zoho Bookings registration form. Currently, Zoho Bookings only supports text-based fields (e.g., Single Line, Multi-Line, Email, Checkbox, Dropdown, Radio Button, and Date), butMerge Tags Output Incorrect Placeholder Text After CRM Sync
Hi everyone, I’m experiencing an issue with merge tags in Zoho Campaigns after last sync of contacts and leads from Zoho CRM (days before everything worked perfectly). Here’s the situation (seems like a default configuration in Campaigns) : My leads haveUI Improvement - Ability to Collapse Flow
The UI for Flow is generally pretty good. However, when multiple decision trees are used, the layout can get pretty convoluted and hard-to-follow (see one of my Flows below): In these cases, even the auto-arrange fails to make this something that a normalWindows agent 2025_M02 release notes
Agent Version: 111.0.3.300 Release date: 24 February, 2025 Various Major enhancements to improve overall performance and optimize the user experience. Squashed a few bugs to improve overall product quality.Windows agent 2025_M01 release notes
Agent Version: 111.0.3.299 Release date: 05 February, 2025 Major Enhancement: Live Monitor feature compatibility released. Major Enhancement: Updated Scaling for multi technician cases with Android and Web based viewers. Various other bug fixes and performancehow to record deferred revenue?
Dear Zoho Team, We issue invoices relating to 12-month web hosting service. When we issue the invoice, we should record the entire amount of the invoice as DEFERRED REVENUE (ie. $10 x 12 mths = $120, balance sheet item). After the particular month of the hosting service, $10 of revenue has been earned and deferred revenue amount will be $110. We must keep adjusting the balance sheet and income statement over the course of the service until the company has fulfilled its obligation of services andNext Page