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 #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.Celebrating 200 posts of Kaizen! Share your ideas for the milestone post
Hello Developers, We launched the Kaizen series in 2019 to share helpful content to support your Zoho CRM development journey. Staying true to its spirit—Kaizen Series: Continuous Improvement for Developer Experience—we've shared everything from FAQsKaizen #193: Creating different fields in Zoho CRM through API
🎊 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.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
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
Adding Chargebee as a Data Connector
Is it possible to get Chargebee added as a Zoho Analytics data connector?Delete commerce website
I need to delete a commerce website, but the only option is to click on settings, REQUEST DELETE, choose an urgency notice, add a message....AND THEN nothing, no way to send the request. Why is nothing simple!?!?! I just want to delete the store. TheAdding external users to Zoho Social under Zoho ONE licence - how to best achieve this
My client has a small business, and we are looking to implementing Zoho ONE with a single flexible user licence as that is all they really need and offers the best pricing for the range of modules we eventually wish to set them up with, one of which willHas anyone built a custom AI support agent inside Zoho (SalesIQ/Zobot)?
Hi all, I’ve been experimenting with building my own AI support assistant and wanted to see if anyone here has tackled something similar within Zoho. Right now, I’ve set up a Retrieval-Augmented Generation (RAG) pipeline outside of Zoho using FAISS. ItThis mobile number has been marked spam. Please contact support.
Problem Description: One of our sales agents in our organization is unable to sign in to Zoho Mail. When attempting to log in, the following message appears: This mobile number has been marked as spam. Please contact support at as@zohocorp.com @zohocorpZoho Books - Hide Convert to Sales Order if it can't be used.
Hi Books team, I noticed that it is not possible to convert a Quote to a Sales Order when a Quote is not yet marked as accepted. My idea is to not show the Convert to Sales Order button when it is not possible to use it, or show it in a grey inactiveWhat’s New in Zoho Inventory | April 2025
Hello users, April has been a big month in Zoho Inventory! We’ve rolled out powerful new features to help you streamline production, optimise stock management, and tailor your workflows. While several updates bring helpful enhancements, three major additionsZoho Books - Quotes to Sales Order Automation
Hi Books team, In the Quote settings there is an option to convert a Quote to an Invoice upon acceptance, but there is not feature to convert a Quote to a Sales Order (see screenshot below) For users selling products through Zoho Inventory, the workflowWhen Zoho Tables Beta will be open to EU data center
Hello all, We in EU are looking at you all using and testing and are getting jealous :) When we will be able to get into the beta also? We don't mind testing and playing with beta software. Thank you!Pass current date to a field using Zoho Flow
I am trying to generate an invoice automatically once somebody submits a record in Zoho CRM. I get an error in the invoice date. I have entered {{zoho.currentdate}} in the Date field. When I test the flow, I get "Zoho Books says "Invalid value passedAPI: Mark Sales Order as Open + Custom Status
Hi, it's possible to create Custom Status (sub-status actually) states for the Sales Order. So you have Open, Void. Then under Open you can have Open, and create one called Order Paid, Order Shipped, etc etc...which is grouped under Open. I can use theZoho Quartz Screen Recording
Hello, can we get access to Quartz, please, as a standalone solution? It would be great for creating training videos for current and future staff on how to use Zoho software according to our company requirements. Thank youTip 26: How to hide the "Submit" button from a form
Hi everyone, Hope you're staying safe and working from home. We are, too. By now, we at Zoho are all very much accustomed to the new normal—working remotely. Today, we're back with yet another simple but interesting tip--how to hide the Submit button from your forms. In certain scenarios, you may want to hide the submit button from a form until all the fields are filled in. Use case In this tip, we'll show you how to hide the Submit button while the user is entering data into the form, and thenfilter broke my data
I uploaded a file recently from Sheets and it has top 2 rows frozen, with table headers in second row and each one is filterable. somehow my first 2 columns became unfiltered and no matter what I do I cannot reapply the filter?? also didn't realize theyHow do I move Notes around within a Group?
It says here: " You can now sort notes by title (alphabetically), or by date modified and date created. You can even organize your notes by dragging and dropping them into a particular order. To sort your notes, simply go to Settings and tap “Sort By.” Please note: all sort settings will be saved and synced across devices, except for custom sorting. Custom sorting will be device specific."However, I am unable to 'custom sort' in either Notebook for Mac or on the Web. In addition, I can't find theGenerate a link for Zoho Sign we can copy and use in a separate email
Please consider adding functionality that would all a user to copy a reminder link so that we can include it in a personalized email instead of sending a Zoho reminder. Or, allow us to customize the reminder email. Use Case: We have clients we need toZoho Sign: need to leave document pending for up to a year, or maybe there's a better way?
I have zoho one, maybe there's a better way to do this with another service than sending a zoho sign template from zoho crm. At the end of the day this requirement is due to regulations, no matter how dumb it may seem. I'm just looking for a way of gettingSeparate Items & Services
Hi, please separate items and services into different categories. Thank youWhat's New in Zoho Inventory | Q2 2025
Hello Customers, The second quarter have been exciting months for Zoho Inventory! We’ve introduced impactful new features and enhancements to help you manage inventory operations with even greater precision and control. While we have many more excitingMastering Zia Match Scores | Let's Talk Recruit
Feeling overwhelmed by hundreds of resumes for every job? You’re not alone! Welcome back to Let’s Talk Recruit, where we break down Zoho Recruit’s features and hiring best practices into simple, actionable insights for recruiters. Imagine having an assistantWe are unable to process your request now. Please try again after sometime or contact support@zohoaccounts.com
I cannot sign up and return the error of we are unable to process your request now. Please try again after sometime or contact support@zohoaccounts.comMulti-currency - What's cooking ?
Hi, We have been doing this feature for sometime and we would like to give you some glimpses of it. Working with Multi Currency : Multicurrency support gives you the ability to handle business transactions in multiple currencies. You can define a base currency for your organization and add more currencies with exchange rates based on the base currency. Setup : From the setup page, you can manage all the currencies supported by your organization. Currencies pageIntegrating Chatbot with Zoho Creator Application
Is it possible to integrate a chatbot with a Zoho Creator application?How to reduce programmatically the image uploaded by user?
I need a function that will automatically reduce the pixel dimension to 800 x 600 pixels / 180 resolution or (approx. 1.37MB) of image uploaded by user from digital camera, for example, 2271 x 1704 pixels /180 resolution or approx. 11.1MB. After the user selected the image, the function will able to detect if pixels is above 800x600, process the photo (crop/ reduce) and resume upload. Need help...Dark mode for Zoho Creator / Zoho CRM Code editor
Hi Team, Is there any plans for Dark mode in Zoho creator / Zoho Crm code editor and development pages in pipeline?Is there a way to make a button scroll down?
Looking to have a button on a landing page scroll down to another section on the page. Any recomendations outside of coding?Collective-booking event not added to all staff calendars
We assign two staff to certain events. When the client books this event, it adds it to one staff calendar (the 'organiser') but not the other. How can I ensure all staff assigned to a collective booking get the event in their calendar? (A side note: itZOHO Android Client
Hi, I installed the Android app, but it had an issue, so I reinstalled it. I was able to add multiple accounts, but now when I add the next account, it just duplicates the one I already have and will not even allow me to enter the info for another account.I'd like to suggest a feature enhancement for SalesIQ that would greatly improve the user experience across different channels.
Hello Zoho Team, Current Limitation: When I enable the pre-chat form under Brands > Flow Controls to collect the visitor’s name and email, it gets applied globally across all channels, including WhatsApp, Messenger, and Instagram. This doesn't quite alignEnhance Barcode/QR Code scanner with bulk scanning or continuously scanning
Dear Zoho Creator, As we all know, after each scan, the scanning frame closes. Imagine having 100 items; we would need to tap 100 times and wait roughly 1 second each time for the scanning frame to reopen on mobile web. It's not just about wasting time;Non-depreciating fixed asset
Hi! There are non-depreciable fixed assets (e.g. land). It would be very useful to be able to create a new type of fixed asset (within the fixed assets module) with a ‘No depreciation’ depreciation method. There is always the option of recording landManaging Rental Sales in Zoho Inventory
I am aware that Zoho Inventory is not yet set up to handle rental sales and invoicing. Is anyone using it for rentals anyway? I'd like to hear about how others have found work arounds to manage inventory of rental equipment, rental payments, etc. ThMegamenu
Finally! Megamenu's are now available in Zoho-Sites, after waiting for it and requesting it for years! BUT ... why am I asked to upgrade in order to use a megamenu? First: Zoho promised to always provide premium versions and options for all included Zoho-applicationsCannot access KB within Help Center
Im working with my boss to customize our knowledge base, but for some reason I can see the KB tab, and see the KB categories, but I cannot access the articles within the KB. We have been troubleshooting for weeks, and we have all permissions set up, customersZoho Flow to Creator 3001 Respoonse
I have updated my Flows with the new V2 connection to Zoho Creator, but now some Flows do not work. They take in data from a Webhook and are supposed to create a record in Creator, however creator returns a 3001 message along with a failure, but I cannotFile Upload to Work Drive While Adding Records in Zoho Creator Application
Hi I am trying to set a file attachment field in zoho creator form, to enable the user to upload a scanned document from their local pc. The file should be uploaded to zoho workdrive and not to the default zoho creator storage. The file link should beWhy not possible to generate?
Using this https://desk.zoho.com/DeskAPIDocument#TicketCount#TicketCount_Getticketcountbyfield on my ZML script url :"https://desk.zoho.com/api/v1/ticketsCountByFieldValues?departmentId=XXXXXXXXXXX&accountId!=XXXXXXXXX&customField1=cf_country_1:XXXXXX&field=overDue"email
Hi My crm email is not working, can you check, I have zoho one account.Need option to see Mass Emails & Cadences in Gmail Outbox OR a dedicated Zoho Outbox
Hi everyone, Right now, when we send 1:1 emails from gmail (with gmail API connected to Zoho CRM), those emails appear both in gmail's sent folder and in Zoho CRM. That works well. But when we send Mass Emails or Cadence emails form Zoho CRM, they areI can't found API for Sales Receipts
Hello May you please help me to find an API document for Sales Receipts to get data and retrive a custom fields like Invoice and credit notes RegardsNext Page