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

                                                • Desk Community Learning Series


                                                • Digest


                                                • Functions


                                                • Meetups


                                                • Kbase


                                                • Resources


                                                • Glossary


                                                • Desk Marketplace


                                                • MVP Corner


                                                • Word of the Day


                                                • Ask the Experts




                                                    Zoho SalesIQ Resources


                                                          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

                                                                                            Get Started. Write Away!

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

                                                                                              Zoho CRM コンテンツ






                                                                                                Nederlandse Hulpbronnen


                                                                                                    ご検討中の方




                                                                                                          • Recent Topics

                                                                                                          • CUSTOM FUNCTION GIVE ERROR #EVAL!

                                                                                                            CUSTEM FUNCTION CREATE KYA ZOHOSHEET ME US FUNCTION KO USE KIYA LEKIN DATA TO SAHI HAI LAKIN DATA SHEET ME NAHI LAG LAHA HAI KRUPYA SOLVE KARE MY CODE IS float ADDTWO_TWO(float NO1, float NO2) { ADD = NO1 + NO2; return ADD; }

                                                                                                          • Zoho ShowTime: Certificates of Completion - Award your learners with a sense of achievement

                                                                                                            In our increasingly competitive market, professional trainers need to differentiate themselves if they are to survive. One way to do this is to focus on innovation and deliver an ideal learning experience. By developing a renowned certificate program that provides learners with a specialized skill set for a particular industry, both trainees and future prospects will recognize the trainer's leadership in that field. This can help with long-term growth, revenue generation, and even marketing and branding.

                                                                                                          • IMAP Migration from Gmail

                                                                                                            I have been trying to import my email from a Gmail server and keep receiving the following error. I have reduced the security, activated imap and no improvement. The link to the Google support item has not helped. Unable to connect to your account. Please

                                                                                                          • Your Incoming has been blocked and the emails will not be fetched in your Zoho account and POP Accounts Click here to get unblocked.

                                                                                                            When entering my account, this error is thrown at me, and I deleted a good part of my deleted messages, but I still can not unblock it, I would appreciate your help. reservas@lineasperutravel.com

                                                                                                          • Request for Creating Multiple Email Accounts on One Mobile Number

                                                                                                            Dear Zoho Team, I am planning to shift all my work-related communication to Zoho Mail because of its reliability and features. For my work, I need to create 3–4 separate email accounts for different purposes. Could you please confirm if it is possible

                                                                                                          • Signature issue

                                                                                                            Problem: The signature does not appear when replying or forwarding an email. solve issue: settintgs/Signature Check option place a signature above the content with quotation marks

                                                                                                          • mail admin not loading

                                                                                                            i am trying to login to mailadmin ... gears keeps rotating forever... its not a password issue whats so ever ... not cookies issues whatsoever from android app i can login but there so few things to do from there .. i changed ip address the same... i

                                                                                                          • Unify 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: Zoho

                                                                                                          • Changing Account in Quote form does not update address information.

                                                                                                            I am trying to update the address information in a quote I've created. I corrected the address in the "Account" but that did not change in the quote. If I re-enter the Account Name in the Quote form, nothing updates. How do I fix this?

                                                                                                          • Zoho One Backup of entire account

                                                                                                            Hello, When using Zoho one is there a way to backup your entire account of all apps that you are using \ activively using in a single step or do you have to backup each applications data individually? Thanks,

                                                                                                          • ZIA in Zoho Cliq

                                                                                                            Is It possible to use the ZIA feature from Zoho Analytics in the Zoho Cliq?

                                                                                                          • Issue with “CC” and “Subject Details” of the initial mail when reply / replied all / forward using Zoho Mail Client (Desktop / Web Mail / Mobile App)

                                                                                                            It is observed that when I reply / reply all / forward a mail using Zoho Mail Client (Desktop / Web Mail / Mobile App), the “CC” and “Subject Details” are omitted from the mail which was replied/forwarded. However this is not the case with outlook mail

                                                                                                          • Unable to send Emails - 452 4.3.1 Temporary System Error

                                                                                                            Whene ever i request smtp server to send the email (without attachment). i recieve error "452 4.3.1 Temporary System Error"

                                                                                                          • I can't receive email

                                                                                                            I cannot receive any email sent to my Zoho email after the free upgrade plan trial is finished.

                                                                                                          • Help for the alisa adding

                                                                                                            Sorry, I would like to add a paypal alias on my domain email address. However, the system blocked it. How can I do it?

                                                                                                          • Problem with Writer and Workdrive

                                                                                                            Hi team, I’m the super admin for our Zoho One org. WorkDrive is active, and Zoho Docs is deprecated for our org. However, Zoho Writer cannot connect to WorkDrive at all — we’ve cleared cache, tried incognito, and restarted several times. I was able to

                                                                                                          • Lite plan attachment said 250mb but actually 25mb ?

                                                                                                            Lite plan attachment said 250mb but actually 25mb ? I can't attach over 25mb files, and can't receive mails has attached files over 25mb too

                                                                                                          • Zoho Books | Product updates | August 2025

                                                                                                            Hello users, We’ve rolled out new features and enhancements in Zoho Books. From the right sidebar where you can manage all your widgets, to integrating Zoho Payments feeds in Zoho Books, explore the updates designed to enhance your bookkeeping experience.

                                                                                                          • Constant color of a legend value

                                                                                                            It would be nice if we can set a constant color/pattern to a value when creating a chart. We would often use the same value in different graph options and I always have to copy the color that we've set to a certain value from a previous graph to make

                                                                                                          • Can no longer export as pdf

                                                                                                            In NOTEBOOK I am no longer able to export notes to pdfs as I used to be able to. When I hit that command it asks where I want to send it, but no matter what I chose there is no pdf attachment that shows up in order to send. Nothing happens.

                                                                                                          • Option to Customize Career Site URL Without “/jobs/Careers”

                                                                                                            Dear Zoho Recruit Team, I hope you are doing well. We would like to request an enhancement to the Career Site URL structure in Zoho Recruit. In the old version of the career site, our URL was simply: 👉 https://jobs.domain.com However, after moving to

                                                                                                          • Old vs New Value for Deleted Lookup Values

                                                                                                            Suppose the following scenario, where a value in a lookup is deleted: 1. User has countries form 2. Form A has a lookup to countries form 3. User selects Italy in Form A and saves it with the Italy ID 4. Form A report shows Italy 5. Italy is inadvertently

                                                                                                          • Desktop app doesn't support notecards created on Android

                                                                                                            Hi, Does anybody have same problem? Some of last notecards created on Android app (v. 6.6) doesn't show in desktop app (v. 3.5.5). I see these note cards but whith they appear with exclamation mark in yellow triangle (see screenshot) and when I try to

                                                                                                          • customize payment page

                                                                                                            Is there a way to customize, other than the theme colour, the payment page that customers are taken to from invoices? I can't seem to find a way. I just don't like the formatting of the current page and would like to make it look better. I've looked at

                                                                                                          • Are Environments Worth It?

                                                                                                            In concept, Environments in ZC is a great idea. I think the flow is pretty smart when you compare it to GitHub, especially for a low code audience. However, in practice, I've found it to be unpredictable, and I've only used it a few times. Aside from

                                                                                                          • Enhanced duplicate check for Leads in CRM

                                                                                                            Hello Everyone, We are excited to announce that you can now check for duplicate entries in leads by comparing them with similar records in the Contacts Module. Previously, when you added a lead, only the converted leads were checked for duplicates. This

                                                                                                          • Pause(1);

                                                                                                            I'm using scheduler to invoke an interaction via http post with an external service. The schedule code uses a for-each loop that runs so fast my external application's log files get messed-up (they are named by date-time stamp). What I'm suggesting is

                                                                                                          • Integration Request: Elementor

                                                                                                            Integrating Zoho CRM forms with Elementor, the most popular page builder on Wordpress, would be great. I use it for our site, goenergylink.com, and I have had to use Zapier webhooks to be able to connect it with Elementor. The one issue I have run into

                                                                                                          • Vertical images displayed as horizontal

                                                                                                            Some pictures that originally are in vertical position are displayed in horizontal after the upload. It seems that system rotates them by 90 degrees. How can I fix this issue?

                                                                                                          • Ability to Change Visibility of Published YouTube Videos

                                                                                                            Hi Zoho Social Team, How are you? We would like to request an enhancement in Zoho Social regarding the management of already published youtube videos. Currently, after publishing a youtube video through Zoho Social, there is no option to change its visibility

                                                                                                          • Adding anchor links in Zoho CRM email templates

                                                                                                            I know you can add anchor link in Campaigns, but I dont see the option to that in the CRM email template. Am I missing something?

                                                                                                          • Support “Never End” Option for Recurring Meetings in Zoho Meeting

                                                                                                            Hello Zoho Meeting Team, Hope you are doing well. We would like to request support for creating recurring meetings with no end date in Zoho Meeting. Currently, when scheduling a recurring meeting, Zoho Meeting requires us to select a specific end date.

                                                                                                          • openUrl in blueprints

                                                                                                            My customer wants to open a URL at the end of a blueprint transition. Seems this isn't possible right now but it would be very useful. In this thread, https://help.zoho.com/portal/en/community/topic/openurl-not-working the Zoho agent said that it's logically

                                                                                                          • Is it possible to pull the Zoho desk data into Zoho analytics in real time

                                                                                                            Hi - I am looking to add more dashboards and reports of Zoho Desk in analytics. I see there is a schedule to pull the data into analytics, but I'm wondering if there is an option to pull the data in real time instead of a specific interval?

                                                                                                          • CRM x WorkDrive: File storage for new CRM signups is now powered by WorkDrive

                                                                                                            Availability Editions: All DCs: All Release plan: Released for new signups in all DCs. It will be enabled for existing users in a phased manner in the upcoming months. Help documentation: Documents in Zoho CRM Manage folders in Documents tab Manage files

                                                                                                          • Introducing the revamped What's New page

                                                                                                            Hello everyone! We're happy to announce that Zoho Campaigns' What's New page has undergone a complete revamp. We've bid the old page adieu after a long time and have introduced a new, sleeker-looking page. Without further ado, let's dive into the main

                                                                                                          • Ability to Add YouTube Video to Playlist During Publishing

                                                                                                            Hi Zoho Social Team, How are you? While publishing YouTube videos through Zoho Social, we noticed that the platform currently does not allow selecting a playlist at the time of publishing. Instead, we can only add the video to a playlist after it has

                                                                                                          • Introducing Zoho Creator's 2025 Release Projection 2

                                                                                                            Hello Creators! I'm Prakash, from the Creator product management team, and today I'm delighted to unveil our next set of features as part of Release Projection 2 for 2025. With thoughtful analysis and planning, we've curated powerful new capabilities

                                                                                                          • Sharing Form Ownership Among Multiple Users

                                                                                                            I would really like the ability to share form ownership among multiple users. It's frustrating to me that if a co-worker wants to make an edit to a form, I have to transfer ownership to them. It would be great if forms could act like google forms, where multiple people can edit a form and view responses. 

                                                                                                          • Marketer’s Space - Ace Your Spooky-Season Marketing with Pre-designed Templates in Zoho Campaigns

                                                                                                            Hello marketers, Welcome back to another post in Marketer’s Space! We’re in Q4, which means that you have endless opportunities to connect with your audience, starting with Halloween campaigns! In this post, we’ll show you how to design the perfect Halloween

                                                                                                          • Next Page