Kaizen #40 - System-defined fields and their default values in Leads #API

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:
  1. System-defined non-mandatory fields and their default values
  2. 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






                      Zoho Campaigns Resources


                            Zoho Developer Community



                                Bootcamp
                                Community
                                Pricing
                                Webinars
                                What's New
                                Integrations
                                Contact Support
                                Contact Sales

                                  Zoho Survey Resources
                                    Features
                                    Survey Templates
                                    Integrations
                                    Community
                                    iOS Mobile Surveys
                                    Pricing
                                    Android Mobile Surveys
                                    Insurvey Blogs
                                    Insight Blogs
                                    Tips & Tricks





                                                Latest Feature Updates
                                                  What's New in Zoho Desk

                                                  Use cases

                                                  Make the most of Zoho Desk with the use cases.

                                                   
                                                    

                                                  eBooks

                                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho Desk.

                                                   
                                                    

                                                  Videos

                                                  Watch comprehensive videos on features and other important topics that will help you master Zoho Desk.

                                                   
                                                    

                                                  Webinar

                                                  Sign up for our webinars and learn the Zoho Desk basics, from customization to automation and more

                                                   
                                                    
                                                  What's New in Zoho Desk

                                                  • Desk Community Learning Series


                                                  • Meetups


                                                  • Ask the Experts


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner





                                                      Zoho SalesIQ Resources

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

                                                            • Kaizen #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


                                                            Manage your brands on social media
                                                            Access Zoho Social

                                                              Zoho Pagesense Resources


                                                                  Zoho TeamInbox Resources

                                                                    Zoho DataPrep 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

                                                                                      • CRM Community Learning Series

                                                                                        CRM Community Learning Series


                                                                                      • Kaizen

                                                                                        Kaizen

                                                                                      • Functions

                                                                                        Functions

                                                                                      • Meetups

                                                                                        Meetups

                                                                                      • Kbase

                                                                                        Kbase

                                                                                      • Resources

                                                                                        Resources

                                                                                      • Digest

                                                                                        Digest

                                                                                      • CRM Marketplace

                                                                                        CRM Marketplace

                                                                                      • MVP Corner

                                                                                        MVP Corner







                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now


                                                                                            Zoho Show Resources


                                                                                              Zoho Writer Writer

                                                                                              Get Started. Write Away!

                                                                                              Writer is a powerful online word processor, designed for collaborative work.

                                                                                                Zoho CRM コンテンツ








                                                                                                  Nederlandse Hulpbronnen


                                                                                                      ご検討中の方




                                                                                                            • Recent Topics

                                                                                                            • Relative Date Searches

                                                                                                              Currently in the search options, it has "date", "from date" and "to date". I think it would be great if there were options like "date greater than x days ago" and "date less than x days ago". I realise that as a once off you can just use the existing

                                                                                                            • Performance is degrading

                                                                                                              We have used Mail and Cliq for about three years now. I used to use both on the browser. Both have, over the past 6 months, had a severe degradation in performance. I switched to desktop email, which appeared to improve things somewhat, although initial

                                                                                                            • Ask the Experts 23: Customize, utilize, and personalize with Zoho Desk

                                                                                                              Hello everyone! It's time for the next round of Ask the Experts (ATE). This month is all about giving Zoho Desk a complete makeover and making it truly yours. Rebrand Zoho Desk with your organization’s details, customize ticket settings based on your

                                                                                                            • Dear Zoho CEO: Business Growth is about how you prioritise!

                                                                                                              All of us in business know that when you get your priorities right, your business grows. Zoho CRM and Zoho Books are excellent products, but sadly, Zoho Inventory continues to lag behind. Just this morning, I received yet another one-sided email about

                                                                                                            • Payroll In Canada

                                                                                                              Hi, When can we expect to have payroll in Canada with books 

                                                                                                            • Please review and re-enable outgoing emails for my domain

                                                                                                              Hello Zoho Support, I have recently purchased a new domain and set up email hosting with Zoho. However, my account shows "Outgoing Email Blocked". I am a genuine user and not sending bulk/spam emails. Please review and re-enable outgoing emails for my

                                                                                                            • Payroll without tax integrations (i.e. payroll for international)

                                                                                                              It seems as though Zoho waits to develop integrations with local tax authorities before offering Zoho Payroll to Zoho customers in a country. Please reconsider this approach. We are happy Zoho Books customers, but unhappy that we have to run payroll in

                                                                                                            • goingout e mail block

                                                                                                              info@ozanrade.com.tr

                                                                                                            • Incoming mails blocked

                                                                                                              Zoho User ID : 60005368884 My mail Id is marketing#axisformingtechnology.com .I am getting following message "Your Incoming has been blocked and the emails will not be fetched in your Zoho account and POP Accounts. Click here to get unblocked." Please

                                                                                                            • Assistance Needed: Ticket Status Not Updating and Sorting by Last Customer Reply in Zoho Desk

                                                                                                              Hello, I’m facing two issues in Zoho Desk that I’d like your guidance on: Ticket Status Not Updating: When a customer replies to a ticket, the status does not change to Reopened. Instead, it remains in Waiting on Customer, even after the customer’s response

                                                                                                            • Configuring Email Notifications with Tautulli for Plex

                                                                                                              Hi I'm new to Zoho. I am from Canada and I have a I use a web based application called Tautulli for Plex that monitors my Plex media server. It also sends a newsletter to my followers. To set this up they require a "From" email address., a smtp server

                                                                                                            • 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

                                                                                                            • How to Set Up Zoho Mail Without Cloudflare on My Website

                                                                                                              I'm having some trouble with Cloudflare here in Pakistan. I want to configure Zoho Mail for my domain, but I'm not sure how to set it up without going through Cloudflare. My website, https://getcrunchyrollapk.com/ , is currently using CF, but I'd like

                                                                                                            • Spam is Being Forwarded

                                                                                                              I am filtering a certain sender directly to the Trash folder. Those messages are still being forwarded. Is this supposed to happen?

                                                                                                            • IMAP Block

                                                                                                              My two accounts have been blocked and I am not able to unblocked them myself. Please respond to email, I am traveling and this is urgent.

                                                                                                            • "DKIM not configured"

                                                                                                              Hello. I have been attempting get the DKIM verified but Toolkit keeps sending the message that it is not configured, but both Namecheap and Zoho show it as configured properly. What am I missing?

                                                                                                            • Zoho mail with custom domain not receiving email

                                                                                                              i registered zoho mail with my own domain. I can login and access the mail app. I tried to send email from an outlook email account and an icloud email account. Both emails were not received. My plan is free. I also tried to send email from this zoho

                                                                                                            • Set connection link name from variable in invokeurl

                                                                                                              Hi, guys. How to set in parameter "connection" a variable, instead of a string. connectionLinkName = manager.get('connectionLinkName').toString(); response = invokeurl [ url :"https://www.googleapis.com/calendar/v3/freeBusy" type :POST parameters:requestParams.toString()

                                                                                                            • Waterfall Chart

                                                                                                              Hello, I would like to create a waterfall chart on Zoho analytics which shows the movement in changes of budget throughout a few months, on a weekly basis. Should look something like the picture below. Does anyone know how to?

                                                                                                            • Help Center and SEO: Any Benefit to My Domain-Mapped Website Ranking?

                                                                                                              First of, I love the Help Center which I've just decided to integrate into my website to replace its old-fashioned FAQs. So much more to achieve there now! Lots of new benefits to the site visitors and to me in terms of organizing and delivering all the

                                                                                                            • Issue with Importing Notes against Leads

                                                                                                              Hi, I am attempting to import some Notes into Zoho CRM which need to be assigned to various Leads. I have created a csv file which I am testing that contains just one record. This csv file contains the following columns: Note Id Parent Id       (I have

                                                                                                            • Trigger a Workflow Function if an Attachment (Related List) has been added

                                                                                                              Hello, I have a Case Module with a related list which is Attachment. I want to trigger a workflow if I added an attachment. I've seen some topics about this in zoho community that was posted few months ago and based on the answers, there is no trigger

                                                                                                            • Creator Add Records through API - Workflows not triggered ?

                                                                                                              Hi Everyone, I am trying to add records to my Creator application through a third party app that I am developing. Currently, I am testing this through Postman. The records I need to add have a lot of workflows to run to populate dropdowns, fields, use

                                                                                                            • Zoho Error: This Operation has been restricted. Please contact support-as@zohocorp.com for further details

                                                                                                              Hello There, l tried to verify my domain (florindagoreti.com.br) and its shows this error: This Operation has been restricted. Please contact support-as@zohocorp.com for further details. Screenshot Given Below -  please check what went wrong. Thanks

                                                                                                            • Important Update: Changes to Google Translate Support in Zoho SalesIQ

                                                                                                              We’re updating our default chat translation options across all Zoho SalesIQ data centres to offer a more secure, in-house solution for your translation needs. What’s changing? We will be offering Zoho Translate (our in-house tool) as the default translation

                                                                                                            • FSM Improvement Idea - Show an Import button when there is no data

                                                                                                              I am setting up FSM for a client and I noticed that there is no option to import data, see screenshot below. Even when you click Create Contact there is only an option to Import from Zoho Invoice. It is only after you add at lease 1 record that the Import

                                                                                                            • Zoho CRM Community Digest - July P1 | 2025

                                                                                                              Hey everyone, The start of July 2025 marked a special milestone: 200 posts in our Kaizen series! For those new here, Kaizen is a go-to series for Zoho CRM developers, where we regularly share best practices, tips, and expert insights to help you build

                                                                                                            • can't login Kiosk URGENT

                                                                                                              already try, can't login pls help to support. thanks.

                                                                                                            • Join our BI & Analytics Workshop at Zoholics UK 🇬🇧

                                                                                                              Hello users, We are thrilled to announce a hands-on workshop at Zoholics UK, 2025, led by Ashwinth and Alan, our Product Experts. This session is designed for anyone who wants to move beyond raw data and truly understand their business performance using

                                                                                                            • What’s New in Zoho Expense (April – July 2025)

                                                                                                              Hello users, We're happy to bring you the latest updates and enhancements we've made to Zoho Expense over the past three months, which include introducing the Trip Expense Summary report in Analytics, extending Chatbot support to more editions, rolling

                                                                                                            • Weekly Tips: Insert frequently used phrases in a jiffy using Hotkeys

                                                                                                              You often find yourself using similar phrases in an email —like confirming appointments or providing standard information. Constantly switching between the mouse and keyboard interrupts your flow and slows you down.Instead of typing the same phrases over

                                                                                                            • Undo Command in Notebook

                                                                                                              It would be handy to have an Undo in the row of icons at the bottom of the notes.

                                                                                                            • Improved UI for a Seamless User Experience - Calls, Tasks, and Meetings

                                                                                                              Hello all, We are making UI unification across CRM so that the UI experience is seamless across the product. As part of that effort, we have made changes to the details page of activity-based module records—Meetings, Calls, and Tasks. Let's look at these

                                                                                                            • New Customization options in the module builder: Quick Create and Detail view

                                                                                                              Hello everyone, We have introduced two new components to the module builder: Quick create and Detail view. The Quick Create Component It is a mini form used to create a record and associate it to the parent record from a lookup field. For example, if you have a Deals lookup in the Contacts module, then you can associate existing deals or create a deal and associate it with the contact. You can customize this Quick Create form by adding standard as well as custom fields. There is no limit to the number

                                                                                                            • Unable to send message; Reason:554 5.1.8 Email Outgoing Blocked

                                                                                                              Hi, I sent few emails and got this: Unable to send message; Reason:554 5.1.8 Email Outgoing Blocked And now I have few days since I cant send any email. Is there something wrong I did? Also can someone fix this please

                                                                                                            • Cross References Do Not Update Correctly

                                                                                                              I am using cross references to reference Figures and current am just using the label and number, i.e. Figure #. As seen here: When I need to update the field, I use the update field button. But it will change the cross reference to no longer only including

                                                                                                            • Add multiple users to a task

                                                                                                              When I´m assigning a task it is almost always related to more than one person. Practical situation: When a client request some improvement the related department opens the task with the situation and people related to it as the client itself, the salesman

                                                                                                            • Narrative 9: GC—Meaningful conversations that benefit your customers

                                                                                                              Behind the scenes of a successful ticketing system - BTS Series Narrative 9: GC—Meaningful conversations that benefit your customers Customers often seek immediate solutions, which is why self-service options are essential. Guided Conversations provides

                                                                                                            • FSM App Oddity

                                                                                                              We recently rolled out FSM to our technicians, and only one technician is having an issue. He's using an iPhone with iOS 18.6 installed. When he goes to service appointments using the calendar icon at the bottom of the app, he gets a list view only. Typically,

                                                                                                            • Cliq Not Working !

                                                                                                              Zoho Cliq has been experiencing connectivity issues since this morning. The app is unable to establish a connection with the server.

                                                                                                            • Next Page