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 Developer Community





                                      • Desk Community Learning Series


                                      • Digest


                                      • Functions


                                      • Meetups


                                      • Kbase


                                      • Resources


                                      • Glossary


                                      • Desk Marketplace


                                      • MVP Corner


                                      • Word of the Day


                                      • Ask the Experts



                                          Zoho Marketing Automation


                                                  Manage your brands on social media



                                                        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

                                                                                                  • My workflows not working

                                                                                                    Hi I have created my first workflow I want it so when a customer responds to a ticket that the status is changed to "reopened" We want this so its clear there is a ticket to deal with again. We only have 2 agents responding to tickets and do not have
                                                                                                  • Waiting Room

                                                                                                    Is there any plans to implement a Virtual Waiting Room for Attendees on Meetings and or Webinars?
                                                                                                  • Error AS101 when adding new email alias

                                                                                                    Hi, I am trying to add apple@(mydomain).com The error AS101 is shown while I try to add the alias.
                                                                                                  • Global Sets for Multi-Select pick lists

                                                                                                    When is this feature coming to Zoho CRM? It would be very useful now we have got used to having it for the normal pick lists.
                                                                                                  • What's New - January 2025 | Zoho Backstage

                                                                                                    Hi there! As we step into a brand-new year, we’re thrilled to bring you some exciting updates to make event management more enjoyable and efficient. Here’s what we rolled out in January to kick off 2025: Backstage 2.0 now enforced for all users We've
                                                                                                  • How do you do ticket add ons in Backstage?

                                                                                                    Hi Everyone, If you wanted to have general admin tickets and allow for add ons, like camping, or car or Carbon offset. What would you do? Peace Robin
                                                                                                  • Re-create auth token

                                                                                                    I need to re-create a self-client auth token, with the same scopes (and additional ones) as the current token. Is there a way to view the scopes assigned to the current token to ensure that no scopes are missing when creating the new one?
                                                                                                  • Writing on sketch cards is bugged when zoomed in

                                                                                                    When zoomed in, it writes a noticeable distance above or to the side of where you're actually trying to write. The further you're zoomed in, the more noticeable it is. Zooming is also entirely absent on the desktop version.
                                                                                                  • Doesn't let me test my newsletter.

                                                                                                    Hello, I click "Preview and Test". I select the email address to send the test (usually my own email). I send the test email, appears the message "Your test email has been sent", but nothing happens. I mean, there is nothing in my inbox. I also tried
                                                                                                  • Custom Related List anchor tag with tel protocol

                                                                                                    The following code worked great for about a year to create clickable tel and mailto links in a related list in the Deals module. Just this morning, it started displaying the HTML as text. For example: <a href='tel:8882490100'>8882490100</a> Zoho support
                                                                                                  • reset of user password

                                                                                                    User forgot her password, so she requests a password rest, but never gets the email. How do I reset her password, since that function is not an option, even for an administrator?
                                                                                                  • In what case it's better to use Developer Console? Only for marketplace?

                                                                                                    As I can see from the documentation, the limitations are challenging. No Custom API No Page Variables No Custom Connections.
                                                                                                  • commision tracker

                                                                                                    I am after a zoho developer to finish my commission tracker as I hired someone on oDesk that started but now will respond to my emails.I really need to get It finished as it is holding up my plans Thanks Budget : $500 | Duration : a.s.a.p To leave a private message, please click the link for private response in post Action section.
                                                                                                  • Generate a Zoho Sign link

                                                                                                    From time to time I get a response "I never received your you e-document for electronic signature" is there a way to generate a Zoho Sign link to share.
                                                                                                  • Error 403: Forbidden When Updating Email Signature via API

                                                                                                    Hi Zoho Desk team, First, congratulations again on the excellent Zoho API. But, I’m encountering an issue while attempting to update an email signature via the API. Whenever I make a request to update the signature, the response returns an HTTP 403 Forbidden
                                                                                                  • Queues Management ?

                                                                                                    I need to assign the new requirements equally between my support agents. How I can configure this feature in Zoho? Thanks
                                                                                                  • Client Can't View Ticket

                                                                                                    Hi, I created a ticket for my Client since he had an issue. I added him as a Contact as well. My client got a notification in his email that the ticket has been created. When he went to view the ticket on his desktop, the screen was blank. He then viewed
                                                                                                  • Automating Custom Web Link Messages to Customers via Instant Messaging in Zoho Desk

                                                                                                    Hello, I am looking for assistance with Zoho Desk's Instant Messaging feature. Is there a way to automate the sending of a custom web link to customers every day at 6:30 PM? Any guidance or suggestions on how to achieve this would be greatly appreciated.
                                                                                                  • How do you apply field validation to a date field?

                                                                                                    We are using Sign for remote e-signature of liability waivers. The signer must enter a date of birth, and if they are a minor their legal guardian must sign for them. However we have had numerous problems with signers returning an invalid date of birth
                                                                                                  • Implement Regex in Layout and Validation rules

                                                                                                    Hello all, We are excited to announce that users can now implement Regular Expressions (Regex) in our layout and validation rules. This new functionality allows for more flexible rules to be created when designing and validating forms. What is Regex?
                                                                                                  • Zoho Desk Validation Rule Using Custom Function

                                                                                                    Hi all, I tried to find the way to validate fields using custom function just like in Zoho CRM but to no avail. Is there a way to do this?
                                                                                                  • Editing landing page after signup for a webinar

                                                                                                    Hi, how can I edit the landing page after signing up for a webinar. I personalized the email "registration confirmation", which is working fine. Nevertheless after submitting the form, the participant gets redirected to a page, which looks like the standard
                                                                                                  • Kiosk GetRecords can't compare formulas

                                                                                                    (submitted as a help request by accident - should have been a topic) Scenario: I have an "email domain" formula whose value is "@xyz.com" if the e-mail address is brent@xyz.com . I have the same field in Leads and Contacts. So, theoretically, I should
                                                                                                  • Kiosk can't merge picklist or multiselect

                                                                                                    There is no ability to load a multiselect or picklikst field into a kiosk with the values that have been previously selected. So, I essentially have 3 unacceptable options: 1.)Load the value into a text string and include instructions like this: "Picklist
                                                                                                  • Fillable template with dynamic tables?

                                                                                                    Is there a way to build a fillable template so that users can add rows to a table? To describe what I'm trying to accomplish the table has 3 sections; a header row, some number of rows with custom information, and a summary row with totals. I can't figure
                                                                                                  • Tip of the Week - Timeline User Filter for Dashboard

                                                                                                    Does the Date User Filter in your Dashboard leave out a few reports from filtering? This happens when the reports are not created over the same table and the (time) column over which the user filter is created.   To solve this, Zoho Reports has a Timeline User Filter. This filter applies the criteria on all reports, matching it with the best possible date column associated with a report. i.e., if your reports are based on a date column, then it will filter it for that data column.  To know more on
                                                                                                  • Zoho Forms Webhooks - Only sends on submission not on edit.

                                                                                                    Hi There, We have a slightly unique use case for Zoho Forms. We used Zoho Forms for the collection of Guest Lists. When a customer submits their guest list they get an email confirmation. Within this is a link for them to update their guest list before
                                                                                                  • Add Knowledge Base KB Articles to multiple categories

                                                                                                    Greetings,  Love you help center system.  One item that would be incredibly helpful to many of us would be able to add a single Knowledge Base KB article to multiple categories in our system.  It seems it could be quite easy to use a checkbox form, instead
                                                                                                  • What does "Tickets for Review" do?

                                                                                                    What is the purpose of the va nilla view " Tickets for Review?"
                                                                                                  • Report of Leads/Accounts/Deals with no open activities

                                                                                                    How can we replicate the option in filter to only show Leads/Accounts/Deals with no open activities ? The option is present in the filters (please find screenshot) but I am unable to find them in the report. Thanks
                                                                                                  • Cannot set Subform Multiline field to read-only using Client Script

                                                                                                    I am using client script to set different subform fields as read-only It works for Single Line Fields, but when I try to set a Multiline field as Read-only it doesn't work var subform = ZDK.Page.getSubform("Subform_1"); var item_Code_old = subform.getField('Item_Code_Old').setReadOnly(true);
                                                                                                  • Changing Color Theme of Guided Conversations

                                                                                                    Hello, We have recently added Guided Conversations to one of our websites, but I am wondering if there is a way to customize the color scheme so it matches the appearance of the website? Thank you in advance!
                                                                                                  • Lost the ability to sort by ticket owner

                                                                                                    Hi all, in the last week or so, we have lost the ability to sort tickets by Ticket Owner. Unlike the other columns which we can hover over and click on to sort, Ticket Owner is no longer clickable. Is it just us, or are other customers seeing this too?
                                                                                                  • Can't login to Zoho mail

                                                                                                    I'm logged into Zoho but when I try to go in zoho mail I get: Invalid request! The input passed is invalid or the URL is invoked without valid parameters. Please check your input and try again. I just set up my mx records and stuff with namecheap a few
                                                                                                  • Social Media Simplified with Zoho Social: Bridge sales and social media marketing

                                                                                                    Social media marketing has become the go-to strategy for most businesses who are trying to boost awareness of their product/service, create a brand image in the minds of their audience, increase website traffic and engagement, and generate leads. Posting
                                                                                                  • This domain is not allowed to add. Please contact support-as@zohocorp.com for further details

                                                                                                    I am trying to setup the free version of Zoho Mail. When I tried to add my domain, theselfreunion.com I got the error message that is the subject of this Topic. I've read your other community forum topics, and this is NOT a free domain. So what is the
                                                                                                  • Work Orders / Bundle Requests

                                                                                                    Zoho Inventory needs a work order / bundle request system. This record would be analogous to a purchase order in the purchasing workflow or a sales order in the sales cycle. It would be non-journaling, but it would reserve the appropriate inventory of
                                                                                                  • Create Quote does not show the "Product Description" entered as part of the Product setup.

                                                                                                    The product description created as part of the product setup page, does not show in the Create Quote module; The module allows for an additional description to be added but without access to the original stored description. By selecting the product from the "Product Name Lookup" pop-up, the "Product Description" part should be populated from the product record where the user is allowed to further modify it.
                                                                                                  • Allow Itemization for Recurring Expenses

                                                                                                    For whatever reason, one cannot itemize a Recurring Expense. This capability should be added. The use cases to support this is largely the same as what they were to allow for itemization in Expenses. Anything that would need to be itemized for a regular
                                                                                                  • Feature Request – Auto-Save Draft for Interview Assessments

                                                                                                    Hello Zoho Recruit Team, I’d like to suggest a feature that would be incredibly helpful for recruiters conducting multiple interviews. Currently, when filling out an Interview Assessment, there is no option to auto-save progress as a draft. At times,
                                                                                                  • Next Page