Kaizen #205 - Answering Your Questions | Managing Picklists and Enabling History Tracking via Zoho CRM APIs
Hello everyone!
Welcome back to another post in our Kaizen series.
In this post, we will look at how you can manage picklist fields in Zoho CRM using APIs. This topic was raised as feedback to Kaizen #200, so we are taking it up here with more details.
In this post, we will cover the following:
- What is a picklist field in Zoho CRM?
- Picklist vs Multi-select Picklist
- Working with picklist fields via APIs
- Creating a picklist field using the Create Custom Field Metadata API
- Updating a picklist field using the Update Custom Field Metadata API
- Assigning picklist values when creating records using the Insert Records API
- Updating picklist values in existing records using the Update Records API
- History tracking for picklists
- What is history tracking for picklists in Zoho CRM?
- Use case
- Enabling history tracking for a picklist using the Create Custom Fields API
What is a picklist field in Zoho CRM?
A Picklist field is a drop-down field in Zoho CRM that contains a predefined list of values. While creating or updating a record, you can select one value from this list instead of entering it manually. This helps you avoid typing errors.
Example :
A Region field with values East, West, North, and South.
If a lead is from the East, the user simply selects East from the picklist instead of typing it manually.
Picklist vs Multi-select Picklist
Picklist | Multi-select Picklist |
Users can select only one value from the list. | Users can select multiple values at once. |
A standard Region picklist works when a record belongs to only one region. Example : East | A Multi-select Region picklist works when a record spans multiple regions. Example : East, North |
Global picklist / Global set : User can create a picklist in common and associate the created picklist across the modules to maintain accuracy. Refer to Kaizen #161: Global Sets using Zoho CRM APIs for more details.
Working with picklist fields via APIs
Creating a picklist field using the Create Custom Field API
You can create a new Picklist field in a module by calling the Create Custom Field Metadata API. For example, you can create a picklist field named Region with the values: East, West, North, South.
Request URL : {{api-domain}}/crm/v8/settings/fields?module=Leads
Request Method : POST
Sample Input
When creating a picklist field, set its data type as picklist and provide the list of options, each with a mandatory display_value. You can also configure additional properties such as actual_value, lexical sorting, and color coding.
{ "fields": [ { "field_label": "Select Region", "data_type": "picklist", // Specify the data type as picklist "tooltip": { "name": "info_icon", "value": "Select your region here" }, "profiles": [ { "id": "5725767000000026011", "permission_type": "read_write" } ], "pick_list_values": [ { "display_value": "East", //The unique display value for the picklist, which will be displayed in the CRM UI. Use the display_value in API requests during create, update, and upsert operations. "actual_value": "IN_East" //The unique reference value associated with the particular option. }, { "display_value": "West", "actual_value": "IN_West" }, { "display_value": "North", "actual_value": "IN_North" }, { "display_value": "South", "actual_value": "IN_South" } ], "pick_list_values_sorted_lexically": true, //Sorts options alphabetically. Default value is false. "enable_colour_code": true //Allows color coding for picklist options. Default value is false. } ] } |
Note : To create a multi-select picklist field, set the data_type key to multiselectpicklist in the request body ("data_type": "multiselectpicklist").
Sample Response
{ "fields": [ { "code": "SUCCESS", "details": { "id": "5725767000007613005" }, "message": "field created", "status": "success" } ] } |
Updating a picklist field using the Update Custom Field API
The PATCH - Field Metadata API lets you modify an existing Picklist field. Use the Get Fields Metadata API to get your picklist field ID.
You can:
- Add new options
- Update the picklist
- Remove existing options using Update Custom Layout API
Here is a sample request that updates the Select Region dropdown field in the Leads module.
Request URL : {{api-domain}}/crm/v8/settings/fields/5725767000007613005?module=Leads
Request Method : PATCH
Adding a new option to the existing picklist field
Sample Input
{ "fields": [ { "pick_list_values": [ { "display_value": "Central", //adding a new option to the existing picklist field "actual_value": "IN_Central" } ], } ] } |
Updating picklist
{ "fields": [ { "profiles": [ { "id": "5725767000000026011", "permission_type": "read_only" //updating the permission_type } ], "pick_list_values": [ { "display_value": "South Region", //updating the display field's value "id": "5725767000007613010" //unique ID of the option } ], "enable_colour_code": false //disabling color code for the options } ] } |
Note : Use the actual_value or unique ID of a picklist option to update its display value. Use the Get Fields Metadata API or Get Layouts Metadata API to get the details.
Removing existing options using Update Custom Layout API
To remove picklist values, keep only the required options in your input. Any options not included in the request will automatically move to the unused section.
First, fetch the required layout, section, field, and option IDs using the Get Layouts Metadata API. Then, in your request body, specify only the picklist values you want to retain.
Request URL : {{api-domain}}/crm/v8/settings/layouts/5725767000000091055?module=Leads
Request Method : PATCH
Sample Input
{ "layouts": [ { "id": "5725767000000091055", //layout id "sections": [ { "id": "5725767000000209001", //section id "fields": [ { "id": "5725767000007613005", //field id "pick_list_values": [ { "display_value": "Central", "id": "5725767000007626001" }, { "display_value": "East", "id": "5725767000007613004" } ] } ] } ] } ] } |
Here, Central and East regions remain as active picklist options, and West, North, and South regions are moved to the unused section.
Updated response
Use the Get Fields Metadata API to check the updated response. The Central and East are still active options (type: used), and North, South, and West are inactive options (type: unused)
{ "fields": [ . . . { "field_label": "Select Region", "id": "5725767000007613005", "api_name": "Select_Region", "pick_list_values": [ { "display_value": "-None-", "sequence_number": 1, "reference_value": "-None-", "colour_code": null, "actual_value": "-None-", "id": "5725767000007613013", "type": "used" //default option }, { "display_value": "Central", "sequence_number": 6, "reference_value": "Central", "colour_code": null, "actual_value": "IN_Central", "id": "5725767000007626001", "type": "used" }, { "display_value": "East", "sequence_number": 2, "reference_value": "East", "colour_code": null, "actual_value": "IN_East", "id": "5725767000007613004", "type": "used" }, { "display_value": "North", "sequence_number": 4, "reference_value": "North", "colour_code": null, "actual_value": "IN_North", "id": "5725767000007613008", "type": "unused" }, { "display_value": "South", "sequence_number": 5, "reference_value": "South", "colour_code": null, "actual_value": "IN_South", "id": "5725767000007613010", "type": "unused" }, { "display_value": "West", "sequence_number": 3, "reference_value": "West", "colour_code": null, "actual_value": "IN_West", "id": "5725767000007613006", "type": "unused" } ], "data_type": "picklist" } ] } |
Assigning picklist values using the Insert Records API
When you insert a record, you can directly pass the picklist option’s display value (not the ID) in the request body.
Request URL : {api-domain}/crm/v8/{module_api_name}
Request Method : POST
Sample Input
{ "data": [ { "Company": "Zylker", "Last_Name": "David", "Select_Region": "Central" // Picklist value to assign } ] } |
Note:
- When creating, updating, or upserting records,
- You can either pass an existing picklist value or add a new one, through the API. Please note that the new value will only be stored in that record, and will not be added to the picklist field’s metadata.
- In the UI, you can only select from the available dropdown options.
- Always use the display_value of the picklist option, not the picklist option’s ID.
- You can also assign the default option (-None-). In this case, the picklist field’s value will be stored as null ("Select_Region": null)
Sample Response
{ "data": [ { "code": "SUCCESS", "details": { "Modified_Time": "2025-08-23T04:51:39-07:00", "Modified_By": { "name": "Patricia Boyle", "id": "5725767000000411001" }, "Created_Time": "2025-08-23T04:51:39-07:00", "id": "5725767000007623017", "Created_By": { "name": "Patricia Boyle", "id": "5725767000000411001" } }, "message": "record added", "status": "success" } ] } |
Updating picklist values in existing records using the Update Records API
When updating, you also use the picklist display value in the field.
Request URL : {api-domain}/crm/v8/Leads/5725767000007628002
Request Method : PUT
Sample Input
{ "data": [ { "Select_Region": "West" // New picklist value } ] } |
This will replace the existing picklist value with West.
History tracking for picklists
What is history tracking for picklists in Zoho CRM?
You can enable history tracking for a picklist field using the Create Custom Field API. Once enabled, Zoho CRM automatically creates a related list for the tracked picklist and a separate module.
Every time the picklist value changes, Zoho CRM creates a new entry in this related list. Each entry shows the old value, the new value, who made the change, and when it was made, and how long the record stayed in the previous value before moving to the next one.
Use case
Zylker's sales team tracks lead progress through the statuses such as New, Contacted, Qualified, and Converted. The team wants to know how long a lead remains in each status and identify if follow-ups are delayed or leads are not progressing.
You can achieve this by enabling history tracking on the Status picklist. You can also monitor every status change, who made it, and how long the lead stayed in the previous status. This helps the team monitor, identify delays, and improve the follow-up process.
The log stores:
- New Value - updated region in the Moved_To__s key.
- Changed By - user who made the update in the Modified_By key.
- Changed On - date and time when the region was changed in the Last_Activity_Time key.
- Duration - how long the record stayed in the previous value before the change in the Duration_Time and Duration_Days keys.
Enabling history tracking for a picklist using the Create Custom Fields API
Request URL : {{api-domain}}/crm/v8/settings/fields?module=Leads
Request Method : POST
Sample Input
{ "fields": [ { "field_label": "Status", "data_type": "picklist", "pick_list_values": [ { "display_value": "New", "actual_value": "New" }, { "display_value": "Contacted", "actual_value": "Contacted" }, { "display_value": "Qualified", "actual_value": "Qualified" }, { "display_value": "Converted", "actual_value": "Converted" } ], "history_tracking_enabled": true, //(mandatory) Enables history tracking for the picklist "history_tracking": { "related_list_name": "Status History", //Lets you give a custom name to the history related list that CRM creates. "duration_configuration": "time", //Decides how to track the timing of changes: days - History is tracked by days and time - History is tracked by time. Note : Before specifying the time value, enable the duration customization feature in your organization by contacting support@zohocrm.com. "followed_fields": [ // The followed_fields lets you retrieve additional field values whenever the picklist value changes. { "api_name": "Owner" } ] } } ] } |
Sample Response in UI
Sample Response via API
Whenever a picklist option changes, the system creates a new record in the related list module. In this example, Status History is the related list module. The sample response below shows how a particular change looks when retrieved using the Get Records API.
Request URL : {{api-domain}}/crm/v8/Status_History/5725767000007739323
Request Method : GET
Sample Response
{ "data": [ { "Status": "Contacted", "$approval": { "delegate": false, "takeover": false, "approve": false, "reject": false, "resubmit": false }, "Modified_Time": "2025-08-28T06:35:15-07:00", "$currency_symbol": "$", "$field_states": null, "$review_process": null, "$editable": true, "Duration_Time": "6568847", //The system stores the duration in milliseconds. "$sharing_permission": "full_access", "Lead_Owner": { "name": "Patricia Boyle", "id": "5725767000000411001" }, "Moved_To__s": "Qualified", "$orchestration": false, "Last_Activity_Time": "2025-08-28T08:24:44-07:00", "Full_Name": { "name": "Zylker", "id": "5725767000007735001" }, "Modified_By": { "name": "Patricia Boyle", "id": "5725767000000411001", }, "$review": null, "$process_flow": false, "$in_merge": false, "id": "5725767000007739350", "$approval_state": "approved", "$pathfinder": false, "$zia_visions": null } ] } |
Note :
- You can select up to 10 fields in total, with a maximum of 5 user fields for all modules except Deals.
- Encrypted fields cannot be specified.
- In the Deals module,
- History tracking is enabled by default for the Stage picklist field.
- You cannot enable history tracking for any other picklist field in the Deals module.
- You can only update the existing Stage picklist field using the Update Custom Field API.
- You can add up to 6 followed fields, with a maximum of 5 user fields.
We hope this post helps you confidently manage picklists and track their history in Zoho CRM. Try it out, and let us know your experience in the comment section or reach out to us at support@zohocrm.com
Stay tuned for more insights in our upcoming Kaizen posts!
Cheers!
Previous Kaizen : Kaizen# 204 - Answering Your Questions - Perform Field Updates before Blueprint transition via Client Script | Kaizen Directory : Home
Related Links :
Access your files securely from anywhere
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Subramanian K
Sticky Posts
Kaizen #217 - Actions APIs : Tasks
Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.Kaizen #216 - Actions APIs : Email Notifications
Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes areKaizen #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achievedKaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script
Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.Kaizen #210 - Answering your Questions | Event Management System using ZDK CLI
Hello Everyone, Welcome back to yet another post in the Kaizen Series! As you already may know, for the Kaizen #200 milestone, we asked for your feedback and many of you suggested topics for us to discuss. We have been writing on these topics over the
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
年内最後のユーザー向けイベント：5名限定！ 課題解決型ワークショップイベント Zoho ワークアウト開催のお知らせ (12/18)
ANNOUNCEMENT 1 REPLY INSIGHTS ユーザーの皆さま、こんにちは。Zoho ユーザーコミュニティチームの中野です。 12月開催のZoho ワークアウトについてお知らせします。 今回はZoomにて、オンライン開催します。 参加登録はこちら（無料） https://us02web.zoom.us/meeting/register/QHn6kJAcRs-znJ1l5jk0ww ━━━━━━━━━━━━━━━━━━━━━━━━ Zoho ワークアウトとは？ Zoho ユーザー同士で交流しながら、サービスに関する疑問や不明点の解消を目的とした「ZohoAdd "Fetch Composite Item" Action for Inventory
I want to make a Flow that uses information returned in the GET call for Composite Items, and it's not currently available in Zoho Flow. Please consider adding this functionality.Adress Labels for sending of the oder und barcode
We want to print with my address labels to stick on the order of the ware can. there are these options?printing individual labels - Dymo LabelWriter
I am trying to print individual labels to my Dymo LabelWriter - has anyone done this? Latest Update (December 2025): The Canvas Print View is now available! We encourage you all to try it out and share your feedback with us. Learn more here: Zoho CRMZoho Creator for Agriculture
Greetings, I am starting to work on Zoho Creator specifically for the agricultural field, any recommendations, tips or ideas that might be helpful ? Also, if you are interested by any means in working on such project, kindly contact me. The project isCustom Print Layout
I would like to create a custom print layout of a Lead or Contact. Is there a way to do that? What I mean is that if I'm viewing a specific lead or contact I'd like to be able to print or export that lead/contact and only print and/or export certain information.Print View
Nothing happens when I'm in a module , ie; Contacts, and I hit the Print View Button. Even when it does come up and say "loading", nothing loadsGet Holiday ready with Zoho Mail's Offline mode
With the holiday season right around the corner, this is the perfect time to get ready to unplug, relax, and enjoy a well-deserved break. In addition to preparing yourself, you can also make sure your organization members are set for their time away fromZoho CRM Kiosk issues
Firstly this is for a system on the AU servers if that makes a difference. Issues are as follows (For Kiosk): 1. Re-ordering fields in the screen builder is broken. The fields seem to be re-ordering themselves, unless you order everything by moving theZoho Books emails suddenly going to Spam since 11 Nov 2025 (Gmail + now Outlook) — anyone else?
Hi everyone, We migrated to Zoho Books in July 2025 and everything worked fine until 11 Nov 2025. Since then, Zoho Books system emails are landing in customers’ Spam (first Gmail, and now we’re seeing Outlook/Office 365 also starting to spam them). Impactedhow to Solve Conflict Invoices in Zoho POS
Hello Team, I am facing a repeated issue in Zoho POS while saving a sale that contains service-based items. My products are intentionally created as Service (Non-Inventory) items because I do not want to track stock for them. However, every time I tryEmail Template Edits Not Saving
I can make an edit, click save, and see the blue bar annimation at the top, but the edits don't actually save. Important, because my email templates are now broken and clients are receiving bad emails. Tried on Chrome, Firefox and IE.Default Ticket View - Table?
Guys, We mostly use the table view to queue tickets. Maybe I am missing it - but how can I set that view as 'default" for all our agents? Thanks JVDuplicate customers being created in Desk
Hi I've trying to work out why I've getting duplicated customers being created in my desk. I have an external booking system that generates an email when I get a customer booking a job. A booking email gets sent to Desk where I manage the booking andCan I have different users see different pick list values for Potential Stage?
We have some users focusing on new business and others focusing on existing business, and they follow different sales processes/cycles, so we would like them to see different pick list values for Stage (eventually leading up to Closed Won/Lost in both cases). And just to keep it interesting - some of these users will of course do a combination, so would need to see one pick list for their New business potentials and a different pick list for their Existing business ones. Salesforce does thisLinks in Instagram
Hi there, I have been using Later for a while now but keen to come back to Zoho Social as Later doesn't offer tagging of pages on Facebook but they offer something Zoho doesn't. You can add a link to your bio which opens up your profile feed where imagesTracking Snippet not working in Zoho Marketing Automation!
First off, the fact that you have to wait about 12-24 hours for every response is terrible. How are we supposed to conduct business? Second, we have been trying for several days to get the Tracking Code Snippet in marketing automation to work, to no avail.email moderation issue when email is sent in the name of a mail group
Symptom: an email that is sent by a mail group moderator in the name of a moderated mail group is held back for approval. Reproduction: Create a moderated mail group with members and moderators. Allow that mails can be sent in the name of the group (extendedIs there any way to send an Excel received by email to Dataprep?
Every day I receive an email alert with an Excel file that I want to process through a Dataprep pipeline. To do this, I need to: -Save the file to disk -Open the pipeline -Run the pipeline -Update the source -Several clicks to select and open the savedRecruit paid support?
Hi all, Could anyone who has paid support package advise if it provides value for money with regards to support response times? Exploring the idea as unfortunately when we have faced issues with Recruit it has been a 7+ day timescale from reporting toUsing IMAP configuration for shared email inboxes
Our customer service team utilizes shared email boxes to allow multiple people to view and handle incoming customer requests. For example, the customer sends an email to info@xxxx.com and multiple people can view it and handle the request. How can I configureHotmail is blocking the zoho mail IP
Greetings, Since last Tuesday (5 days ago today) I wrote to Zoho support and I still haven't received a single response (Ticket ID: 2056917). Is this how you treat people who pay for your email service? I am making this public so that those who want toRead webpage - MSXML2.ServerXMLHTTP
I have the following VBA script, put together from various sources (mainly zoho forum/help/support, so it once worked, I guess): private Sub GetListOfSheets() Dim url As String Dim xmlhttp As Object Dim parameters As String Dim html As String range("B1").valueZoho Creator Form Search
I'm new to Zoho Creator and so far i do like it but im shocked there seems to be no easy way to add a search function and/or navigation to there forms as this readily available in every platform i have used in the past. Anyway i have a form which i haveHow to setup DKIM / SPF in Zoho Mail
Hello there! I'm having a hard time understanding how to setup the TXT records for SPF and DKIM with Zoho Mail. I'm following the instructions here: https://www.zoho.com/campaigns/help/setup-spf-dkim.html Specifically, when it comes to the value for theMass update cant trigger a workflow?
Hello there, Is this a normal Creator behaviour? In a report, if I manually edit each data row, it will pass those changes to all other reports. However, if I perform a Mass Update on a few data rows at once, the new data is not pushed to other reports.Exciting Updates to the Kiosk Studio Feature in Zoho CRM!
Hello Everyone, We are here again with a series of new enhancements to Kiosk Studio, designed to elevate your experience and bring even greater efficiency to your business processes. These updates build upon our ongoing commitment to making Kiosk a powerfulsearch and Smart Bar both missing in Mail
One of the users on my account does not have the search bar at the top right or the Smart Bar at the bottom left of the desktop Mail app. Any ideas how to get those back?"Wrong password or login" Problem to configure Zoho on MAIL App on my Macbook
Hi, I'm having problems to configure my e-mail on my MAIL App(Macbook pro). My e-mail is hari@trespontoum.net Actually was working perfectly, and still working on my Iphone. My MAIL App prompt me that my login or password is wrong. I tried to change 3Remote Control Functionality During Screen Sharing in Zoho Cliq
Hello Zoho Cliq Team, We would like to request the addition of remote control functionality during screen sharing sessions in Zoho Cliq. Currently, while screen sharing in Cliq is very useful, it lacks the ability for another participant to take controlLet us add Lookup fields in the Blueprint Transitions
We are unable to add Lookup Fields in the blueprint transitions in Zoho Desk, we wanted to make it a requirement for our workflow but since it's not available in the transition we cannot. The lookup field exists in the Layout: But it cannot be added/selectedZoho Projects API Scope for Issue Attachments
I try to download issue attachments via the API, unfortunately I always get the following error code when trying to download the file from the supplied URL: {"ERROR_MESSAGE":"INVALID_OAUTHSCOPE","ERROR_CODE":401} indicating an auth scope error. I've triedHow to fetch custom fields for time entries in Zoho Project API v3
In the previous Zoho Projects REST API, we were able to retrieve custom field details for time entries, including picklist options, using the endpoint: GET /restapi/portal/[PORTAL_ID]/timesheetcustomfields In the new Zoho Projects API v3, we tried usingZoho Survey Enhancements
We love Survey. We use it a ton. It needs some enhancements. Maybe some of these are already on the roadmap? API - this is crucial. We have some complex surveys that take place and need to update records, trigger other functions/automations, etc. I wouldImages Don't Display on Blog
Hi, I've just posted a new blog entry, but regardless of format (png or jpeg) Images that display in Preview mode do not display on any browser in the published post. I've not done anything different with this post than others regarding images, please advice. Thanks! Edit: I've discovered that moving the image files from a my sub directory folder "Pics for Blog" to the top level of the "Files" folder on my site allows the images to display live. This, even though my other blog posts are correctlyCheckbox Field Mapping Zoho Forms to Zoho Sign
I have an application that will be filled out via Forms that I am mapping into a PDF Filler on Zoho Sign. I need to have a series of checkboxes mapped to the corresponding fields in Sign and I only see single checkboxes available via the mapping, thoughMCP > Creator connection failing with Claude
I'm trying to get claude to access any of my Zoho Creator apps and it keeps failing. I have enabled all tools for creator and ensured in claude settings that everything is authorised. Here is what claude says : Unfortunately, the error messages I'm receivingBooks P&L by Customer
Lately, we have found that the Customer field filter for the Profit & Loss report in Zoho Books is no longer available. We have several projects with the same customer and look at the P&Ls by project AND by Customer (overall). Can you please add back in this field selection alongside the Project field to the P&L report filter? Thanks! -GinaSent mail sort by date disappeared
Hello, We used to be able to sort the emails by date in the sent folder, but this feature has recently disappeared. Can we bring it back?I cannot check out to Zoho People.
When I tried to check out today, there's prompt that inhibits me to check out: To add entry in Attendance, log time for any of your jobsNext Page