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
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
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 #198: Using Client Script for Custom Validation in Blueprint
Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Kaizen #226: Using ZRC in Client Script
Hello everyone! Welcome to another week of Kaizen. In today's post, lets see what is ZRC (Zoho Request Client) and how we can use ZRC methods in Client Script to get inputs from a Salesperson and update the Lead status with a single button click. In thisKaizen #222 - Client Script Support for Notes Related List
Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore howKaizen #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 are
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
Zoho Books/Square integration, using 2 Square 'locations' with new Books 'locations'?
Hello! I saw some old threads about this but wasn't sure if there were any updates. Is there a way to integrate the Square locations feature with the Books locations feature? As in, transactions from separate Books locations go to separate Square locationsZoho Commerce - How To Change Blog Published Date and Author
Hi Commerce Team, I'm discussing a project with a client who wants to move from Woo Commerce / Wordpress to Zoho Commerce. They have around 620 blog posts which will need to be migrated. I am now aware of the blog import feature and I have run some tests.Does zoho inventory need Enterprise or Premium subsrciption to make Widgets.
We have Zoho One Enterprise and yet we can't create widgets on inventory.ZMA shows as already connected to Zoho CRM, but integration not working
When I try to connect ZMA with Zoho CRM, it shows as already connected, but the integration doesn’t seem to be working. I’ve attached the screen recording for reference.Automatic Email Alerts for Errors in Zoho Creator Logs
Hello, We would like to request a feature enhancement in Zoho Creator regarding error notifications. Currently, Zoho Creator allows users to view logs and errors for each application by navigating to Zoho Creator > Operations > Logs. However, there isWorkflow Rule - Field Updates: Ability to use Placeholders
It will be great if you can use placeholder tags to update fields. For example if we want to update a custom field with the client name we can use ${CONTACT.CONTACT_FIRSTNAME}${CONTACT.CONTACT_LASTNAME}, etcPassword Assessment Reports for all users
I'm the super admin and looking at the reporting available for Zoho Vault. I can see that there is a Password Assessment report available showing the passwords/weak and security score by user. However I'm confused at the 'report generated on' value. MonitorCan't change form's original name in URL
Hi all, I have been duplicating + editing forms for jobs regarding the same department to maintain formatting + styling. The issue I've not run into is because I've duplicated it from an existing form, the URL doesn't seem to want to update with the newSetting certian items to be pickup only
How do we have some items that are pickup only? I have several items in my item's list that I do not ship. But they need to be on the website to be sold, and picked up in store. Need to be able to do this as one of these products is a major seller forUsing gift vouchers
We would like to be able to offer a limited number of gift vouchers, of varying values, to our customers, and are looking for the best way to do this. We have looked at Coupons and Gift Certificates, but neither seem to fit the bill perfectly. Coupons:Automatically updating field(s) of lookup module
I have a lookup field, which also pulls through the Status field from the linked record. When the lookup is first done, the Status is pulled through - this works perfectly. If that Status is later updated, the lookup field does not update as well. AsZoho Commerce and Third-party shipping (MachShip) API integration
We are implementing a third-party shipping (MachShip) API integration for our Zoho Commerce store and have made significant progress. However, we need guidance on a specific technical challenge. Current Challenge: We need to get the customer input toAdding custom "lookup" fields in Zoho Customization
How can I add a second “lookup” field in Zoho? I’m trying to create another lookup that pulls from my Contacts, but the option doesn’t appear in the module customization sidebar. In many cases, a single work order involves multiple contacts. Ideally,Can you import projects into Zoho Projects yet?
I see some very old posts asking about importing project records into Zoho Projects. But I can't find anything up to date about the topic. Has this functionality been added? Importing tasks is helpful. But we do have a project where importing projectsZoho Inventory. Preventing Negative Stock in Sales Orders – Best Practices?
Dear Zoho Inventory Community, We’re a small business using Zoho Inventory with a team of sales managers. Unfortunately, some employees occasionally overlook stock levels during order processing, leading to negative inventory issues. Is there a way toAutomation #10 - Auto Assign Ticket based on Keywords
This is a monthly series designed to help you get the best out of Desk. We take our cue from what's being discussed or asked about the most in our community. Then we find the right use cases that specifically highlight solutions, ideas and tips on optimizingAutomate attendance tracking with Zoho Cliq Developer Platform
I wish remote work were permanently mandated so we could join work calls from a movie theatre or even while skydiving! But wait, it's time to wake up! The alarm has snoozed twice, and your team has already logged on for the day. Keeping tabs on attendanceReusable Custom Functions Across Department Workflows
Dear Zoho Desk Team, We appreciate the powerful workflow automation capabilities in Zoho Desk, particularly the ability to create and use custom functions within workflows. However, we have encountered a limitation that impacts efficiency and maintainability.Don't Allow Customer to Edit Values After Submitting Ticket
After a customer submits a ticket through the customer portal, they can go into the ticket and see some of the values from the questions they answered in the sidebar. Currently, a customer can edit these values even after they submitted them. This makes no sense. We ask very specific questions that we don't want customers to later change! Please disable the ability for customers to edit the values to their submission questions in the portal. Screenshot attached.Analytics <-> Invoice Connection DELETED by Zoho
Hi All, I am reaching out today because of a big issue we have at the moment with Zoho Analytics and Zoho Invoice. Our organization relies on Zoho Analytics for most of our reporting (operationnal teams). A few days ago we observed a sync issue with thetext length in list report mobile/tablet
Is there a way to make the full text of a text field appear in the list report on mobile and tablet? With custom layouts, the text is always truncated after a certain number of characters.Automation #4 - Auto Delete Tickets based on Rules
This is a monthly series in which we pick some common use cases that have been either discussed or most asked about in our community and explain how they can be achieved using one of the automation capabilities in Zoho Desk. Unwanted tickets spammingZoho Community Digest — Enero 2026
¡Hola, comunidad! 🌟 Aquí os traemos las novedades más interesantes de Zoho durante este mes de enero, incluyendo actualizaciones de productos, integraciones y un recordatorio sobre los workshops certificados que vuelven a España. 🎓 Eventos y ComunidadAutomation #3 - Auto-sync email attachments to tickets
This is a monthly series where we pick some common use cases that have been either discussed or most asked about in our community and explain how they can be achieved using one of the automation capabilities in Zoho Desk. Most of our customers use emailAutomation #11 - Auto Update Custom Fields with Values from Emails
This is a monthly series designed to help you get the best out of Desk. We take our cue from what's being discussed or asked about the most in our community. Then we find the right use cases that specifically highlight solutions, ideas and tips to optimizeAutomation #13 - Auto assign tickets based on agent shift time
This is a monthly series designed to help you get the best out of Desk. We take our cue from what's being discussed or asked about the most in our community. Then we find the right use cases that specifically highlight solutions, ideas and tips to optimizeAutomation #14: Capture Jira Issue Key/ID in a Ticket Custom Field
Hello Everyone! This month's edition brings you a custom function to consolidate your records associated with Jira integration. Jira integration enables support engineers and R&D units to collaborate seamlessly on feature development, product improvement,Automation #16: Automate Ticket Reopening on Scheduled Timestamp
Hello Everyone! This edition uncovers the option to schedule reopening a ticket automatically. Zylker Finance tracks insurance policyholder activities through Zoho Desk. For policyholders who pay monthly premiums, tickets are closed upon payment completion.Automation#19:Auto-Close Tickets Upon Task Completion
Hello Everyone! We’re excited to bring you another custom function this week. In this edition, we’ll show you how to automatically close tickets when all associated tasks are marked as completed. Let’s see how ZylkaPure, a leading water filter company,Automation #15: Automatically Adding Static Secondary Contacts
Rockel is a top-tier client of Zylker traders. Marcus handles communications with Rockel and would like to add Terence, the CTO of Zylker traders to the email conversations. In this case, the emails coming from user address rockel.com should have TerenceImproved UX design for Projects CRM integration
The current integration embeds the entier projects inteface into the CRM this is confusing and allows users to get lost. For example as a user i navigate to an account and go down to the related projects list and want to get information about a specificLink Purchase Order to Deal
Zoho Books directly syncs with contacts, vendors and products in Zoho CRM including field mapping. Is there any way to associate vendor purchase orders with deals, so that we can calculate our profit margin for each deal with connected sales invoicesTransformer vos stocks en décisions intelligentes avec Zoho Inventory et Zoho Analytics
Zoho Inventory permet de suivre facilement les niveaux de stock et d’anticiper les restockages. Pour de nombreuses entreprises, cela suffit à gérer les opérations au quotidien. Mais à mesure que l’activité se développe, cette clarté peut commencer à montrerSecurity Enhancements | Migrate to the Updated Policies
Hello everyone, Zoho Directory's security policies have been updated and reorganized into three new policies with features that enhance the overall organization security. These policies provide a stronger and more secure sign-in methods and improve theBring Zoho Shifts Capabilities into Zoho People Shift Module
Hello Zoho People Product Team, After a deep review of the Zoho People Shift module and a direct comparison with Zoho Shifts, we would like to raise a feature request and serious concern regarding the current state of shift management in Zoho People.Facturation électronique 2026 - obligation dès le 1er septembre 2026
Bonjour, Je me permets de réagir à divers posts publiés ici et là concernant le projet de E-Invoicing, dans le cadre de la facturation électronique prévue très prochainement. Dans le cadre du passage à la facturation électronique pour les entreprises,Quick Create needs Client Script support
As per the title. We need client scripts to apply at a Quick Create level. We enforce logic on the form to ensure data quality, automate field values, etc. However, all this is lost when a user attempts a "Quick Create". It is disappointing because, fromHow to block a WhatsApp user for sending spam
Is there a way to block those whatsapp users that just come to play and annoy our service, they also spam us. We have a waba service with sales iqInquiry regarding auto-save behavior for Zoho Sign Embedded Sending
Dear Zoho Support Team, I am currently integrating Zoho Sign's Embedded Sending functionality using iframes on my website. I would like to know if there is a way to ensure that the document state (including any added fields) is automatically saved asIntroducing Connected Records to bring business context to every aspect of your work in Zoho CRM for Everyone
Hello Everyone, We are excited to unveil phase one of a powerful enhancement to CRM for Everyone - Connected Records, available only in CRM's Nextgen UI. With CRM for Everyone, businesses can onboard all customer-facing teams onto the CRM platform toNext Page