Actions APIs - Field Updates
Hello all!!
Welcome back to a fresh Kaizen week.
In the previous weeks, we covered Workflow Rules APIs, Actions APIs - Email Notification APIs, and Tasks Update APIs.
This week, we will continue with another Actions API - the Field Update API in Zoho CRM.
Field Updates in Zoho CRM
The Field Update option helps you automatically update specific field values in records when the associated workflow rule is triggered.
Note: Field Updates can also be used in Blueprint and Approval Processes, but in this post, we will focus only on Field Updates used with Workflow Rules in Zoho CRM.
When multiple leads enter Zoho CRM each day, from small to large industries, the Sales team manages all these entries inside a module. Every single lead is important for a company, whether it comes from a small or large industry. High-profit leads should not be missed and must be treated with high priority, frequent follow-ups, and faster actions to convert them into won deals.
High-profit deals without Field Update
There are chances of missing or failing to prioritize high-profit deals when all entries are cluttered inside the same module. This leads to manual mistakes and confusion for the Sales team. It becomes manual work, which increases the possibility of missing high-profit Leads.
High-profit deals with Field Update
A Field Update + Workflow Rule can solve these issues by creating an automated process. This avoids manual intervention and reduces errors.
Use case
Zylker, an IT solutions provider, wants to give high-priority attention to leads coming from large industries or leads that have a high lead score, especially when the Lead Status is Not Contacted.
Whenever a lead has a Lead Score ≥ 80 and is Not Contacted, the system should automatically update a field called Profit Category and set it to High Profit.
Why Lead Score for our use case?
Lead Score shows how active and interested a lead is. A score of 80 or above means the lead is highly engaged and more likely to convert. This makes it a dependable way to identify important leads that need quick attention.
Scenario
Whenever a lead meets the following conditions:
- Lead Score ≥ 80
- Lead Status = Not Contacted
The system should automatically update the Profit Category field to High Profit, and add a Contact Immediately tag. This helps the Sales team quickly identify high-profit records even when many records are cluttered in the module.
This can be achieved using a Field Update combined with a Workflow Rule.
Why not just use a Custom View?
A custom view can filter and display leads that meet these conditions, but it still depends on the Sales team to open the view and take action. In a busy Leads module, important leads can be missed or delayed. Also, if you want to perform dependent actions, you will need to create and schedule a custom function manually.
With a Workflow and Field Update, the system emails and also trigger many other actions like Field Update, Webhooks, and so on to your executives about these leads automatically. In our case, the Profit Category and tag are updated the moment the lead meets the condition, making high-profit leads stand out everywhere in CRM - without relying on manual checks or someone remembering to look at a view.
Profit Category mapping based on Lead Score
Profit Category is a custom picklist field in the Leads module.
The following table shows how Zylker classifies profit categories based on Lead Score:
Lead Score | Profit Category |
20-40 | Minimal Profit |
40-60 | Average Profit |
60-80 | Good Profit |
80+ | High Profit |
In this use case, we focus only on the High Profit category.
Let us now see how to enable a Field Update in Zoho CRM through the UI.
Creating a Field Update via UI
To create a Field Update in Zoho CRM, follow the steps below:
- Go to Setup > Automation > Actions > Field Updates.
- Click Create Field Update.
- Enter the Name of the field update.
- Select the Module.
- Choose the Field that should be updated.
- Provide the value to be updated that must be applied.
- Save the Field Update.
Field Update Configuration
In this use case, a Field Update is created to modify the Profit Category field when the workflow rule is triggered.
Field Update Details:
- Name: Profit Category
- Module: Leads
- Field to Update: Profit Category
- New Value: High Profit
This Field Update will be used as an action inside the workflow rule.
How to create the workflow for this use case and associate this Field Update with the workflow has been covered in the following section of this post.
UI - Field Update Creation ViewCreating a Field Update via API
You can create a Field Update using the Create Field Update API available from Zoho CRM API version 8.
Request URL: {{api-domain}}/crm/v8/settings/automation/field_updates
Request Method: POST
Input JSON
{ "field_updates": [ { "name": "Profit Category ", "module": { "api_name": "Leads", "id": "5725767000000002175" }, "type": "static", "feature_type": "workflow", "field": { "api_name": "Profit_Category", "id": "5725767000008570298" }, "value": "High Profit" } ] } |
Keys explanation
Key | Explanation |
field_updates
| Holds all details to create a field update. |
name | Field Update name |
module | Specify the module details |
module.api_name | Represents the module API name. In our case, it is "Leads" module. |
module.id | Represents the System ID for the module |
type | Represents the Update type. Usually “static” for fixed-value updates. |
feature_type | Represents that this Field Update is for workflow Rules. |
field | Represents which field should be updated. |
field.api_name | Represents the field API name. |
field.id | Represents the unique ID of the field. |
value | The value to be updated |
Sample Response
{ "field_updates": [ { "code": "SUCCESS", "details": { "id": "5725767000008604002" }, "message": "field update deleted successfully", "status": "success" } ] } |
A note on the unique ID
You can add:
- You need this ID to retrieve, update, and delete the Field Update later.
Retrieve your Field Update
You can retrieve a Field Update by using the Get Field Update API. It lists all available Field Update actions available in your org.
Request URL: {{api-domain}}/crm/v8/settings/automation/field_updates/5725767000008604002
Request Method: GET
Sample Response:
Below is the sample response returned by Zoho CRM.
{ "field_updates": [ { "created_time": "2025-11-15T07:57:39-08:00", "update_type": null, "lock_status": { "locked": false }, "apply_assignment_threshold": false, "editable": true, "module": { "api_name": "Leads", "id": "5725767000000002175" }, "related_module": null, "deletable": true, "source": "crm", "type": "static", "created_by": { "name": "Patricia Boyle", "id": "5725767000000411001" }, "notify": false, "feature_type": "workflow", "modified_time": "2025-11-15T07:57:39-08:00", "field": { "api_name": "Profit_Category", "id": "5725767000008570298" }, "dependent_fields": null, "associated": false, "related_records": null, "name": "Profit Category Leads", "modified_by": { "name": "Patricia Boyle", "id": "5725767000000411001" }, "id": "5725767000008604002", "value": "High Profit" } ] } |
Note: This API helps you fetch all the details of a specific Field Update using its unique ID. Also, you can create a workflow and associate the created Field Update action using its unique ID.
Workflow Rule Configuration
Trigger:
- When a Lead is created or edited.
Condition:
- Lead Score is greater than or equal to 80.
- Lead Status is currently Not Contacted.
Actions:
- Associate the created Field Update action: High Profit
- Add a Contact Immediately tag to the record.
Workflow Rule and Field Update action via UI
Configuring Workflow and associating the Field Update actionWorkflow Rule and Field Update action via API
Create a Workflow:
You can use the Configure Workflow Rule API to create a workflow.
Associate the Field Update:
You can associate the Field Update action with the workflow by using the unique ID of the Field Update.
Retrieve the Field Update ID using the Get Field Updates API.
Request URL: {{api-domain}}/crm/v8/settings/automation/workflow_rules
Request Method: POST
Sample Input:
{ "workflow_rules": [ { . . . "execute_when": { "details": { "trigger_module": { "api_name": "Leads", "id": "5725767000000002175" }, }, "type": "create_or_edit" }, "module": { "api_name": "Leads", "id": "5725767000000002175" }, "conditions": [ { "instant_actions": { "actions": [ { "name": "Profit Category", "details": { "module": { "api_name": "Leads", "id": "5725767000000002175" } }, "id": "5725767000008604002", //associating the created Field Update with the Workflow. "type": "field_updates" }, { "name": "High Priority Deal", "details": { "module": { "api_name": "Leads", "id": "5725767000000002175" }, "over_write": false, "tags": [ { "name": "High Priority Deal", "id": "5725767000008570458", "color_code": "#63C57E" } ] }, "id": "5725767000008570470", "type": "add_tags" } ] }, "criteria": { "group_operator": "AND", "group": [ { "comparator": "greater_equal", "field": { "api_name": "Entity_Scores__s.Score", //Lead Score's API name "id": "5725767000002324045" }, "type": "value", "value": "80" }, { "comparator": "contains", "field": { "api_name": "Lead_Status", "id": "5725767000000002611" }, "type": "value", "value": "Not Contacted" } ] } } ] . . . } ] } |
For more details on Workflow Rules using APIs, refer to Kaizen #213 - Workflow APIs - Part 1, Part 2, and Part 3.
Edit your existing Field Update
You can update an existing Field Update using the Update Field Update API. To update it, use the unique ID of the Field Update in the request URL. Use Get Field Update API to get the required Field Update ID.
Request URL: {{api-domain}}/crm/v8/settings/automation/field_updates/5725767000008599001
Request Method: PUT
Input JSON
{ "field_updates": [ { "name": "Profit Category - Updated", //updated the response "field": { "api_name": "Profit_Category", "id": "5725767000008570298" }, "value": "Good Profit" //updated value } ] } |
Note:
- Only the configured modules cannot be updated using the PUT - Field Update API call. The rest of the fields can be updated.
- The updated value must be valid for the field type. For example, picklist fields accept only existing picklist options.
- After updating a Field Update, any workflow linked to it will automatically start using the updated configuration.
Delete Your Existing Field Update
You can delete an existing Field Update using the Delete Field Update API. To delete it, you must use the unique ID of the Field Update in the request URL.
If you do not know the ID, use the Get Field Update API to retrieve it.
Request URL: {{api-domain}}/crm/v8/settings/automation/field_updates/5725767000008599001
Request Method: DELETE
Sample Response:
{ "field_updates": [ { "code": "SUCCESS", "details": { "id": "5725767000008604002" }, "message": "Field update deleted successfully", "status": "success" } ] } |
Note
- You cannot delete a Field Update if it is currently associated with any Workflow, Blueprint, or Approval Process. Remove the Field Update from the workflow first, and then try deleting it.
We hope this post helps you understand how to use Field Updates through the Zoho CRM Actions API - Field Update API.
Try it out, and let us know your experience in the comments section or reach out to us at support@zohocrm.com.
Stay tuned for more insights in our upcoming Kaizen posts!
Cheers!
Workflow Rules and Actions APIs on Kaizen series:
Workflow Rules:
- Kaizen #213 - Workflow APIs - Part 1
- Kaizen #214 - Workflow APIs - Part 2
- Kaizen #215 - Workflow APIs - Part 3 - Create and Update Workflow Rules
Actions APIs:
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
Recent Topics
Zoho account sign in with passkey
Hello, I am trying to sign in using passkey, but the option doesn't show up in the web and is disabled in Oneauth on mobile, saying the admin has restricted the use. On the Admin page in Security MFA I can find no option for passkey. Help would be greatlyRescheduled US meetups: Zoho Desk user meetups are coming to seven U.S. cities in October and November, 2025
Hello to our Zoho Desk users in the United States, We're excited to share the revised dates for the upcoming Zoho User Groups happening across the US this summer. Our product experts are heading to seven cities throughout the country, and for the firstChecklists as templates
Is it possible to save checklists as templates to reuse them in other tasks? Example: I have a web project. I maintain individual web URLs as tasks. Within the tasks the same checklist should be used again and again: - Page created in CMS - PropertiesSend mass email using my secondary email
Hello, When I send an email to just one person from Zoho CRM, a complete email editor appears, where I can choose which of my email addresses I want to use in the From field. When I send a mass email, there is not such option. I can only select the emailZOHO TEAM INBOX Calendar Integration
The Problem: Clients send meeting invitations to our TeamInbox address. TeamInbox receives these invites, but we cannot accept them. We do not use individual inboxes for transparency purposes. Ideal Solution: A way to accept calendar invites sent to ourWhy Can't I add unicode emoji's to my signature?
Why would Zoho Mail prevent me from adding unicode emojis to my email signature? Every time I try to save the signature, Zoho Mail erases the emoji and any nearby content. Every time I setup something with Zoho, I know I'm going to run into some incrediblyUnearned / Deferred Revenue Automatic Calculation for Subscriptions
As a SaaS business, we have multiple active subscriptions with varying dates and amounts. Is there a way to have a monthly automatic calculation for all of them that debits or credits the unearned revenue and revenue accounts accordingly? Alternatively,Zoho Desk Limit for Comma Separated Queries
Hi, I have just discovered a limit that I believed is not mentioned in any of Zoho's documentations. My search query looks like so: "query: {"accountId":"786050000091629966,786050000163589273,786050000163589427,786050000162753705,786050000162112971,786050000161987643,786050000160752868,786050000167089504,786050000167089378,786050000167089024,786050000167070005,786050000166295256,786050000128153693,786050000110560021,786050000046594575,786050000039106461,786050000002225356,786050000076889093,786050000047895103,786050000043365354,786050000044765191,786050000041790249,786050000040359116,786050000037945198,786050000024605077,786050000000525015,786050000155333895,786050000157741437,786050000000718125,786050000011574353,","departmentId":"786050000042648070","status":"Finished","sortBy":"createdTime","customField2":"cf_completion_date:2025-01-28T03:00:00.000Z,2025-10-28T03:00:00.000Z","customField3":"cf_billed:false"}"Module Name doesn't exist
I am trying to create a module named Activity, with plural Activities, but I have an error that module name already exists. This module is doesn't exist, and I don't have a single field called Activity or Activities.Zoho Desk iOS and Android app update: AI powered: Reply Assistance and Refine Messages on IM module.
Hello everyone! We are excited to introduce new AI powered features on the IM module of the Zoho Desk app. Reply Assistance: Reply Assistance generates suggested responses for incoming chat messages, which you can directly insert into the conversationIs it possible to embed Youtube shorts?
Hi Zoho desk support, This is Ryan from Accuver America. While I'm trying to create a knowledge base article with embed video, I ran into this issue. "www.youtube.com refuse to connect" A little bit background is that because this video is recorded onSplit functionality - Admins need ability to do this
Admins should be able to split an expense at any point of the process prior to approval. The split is very helpful for our account coding, but to have to go back to a user and ask them to split an invoice that they simply want paid is a bit of an inDelegates - Access to approved reports
We realized that delegates do not have access to reports after they are approved. Many users ask questions of their delegates about past expense reports and the delegates can't see this information. Please allow delegates see all expense report activity,How to include total km for multiple trips in expense report.
Whenever I create a mileage report it only shows the total dollar amount to be reimbursed. The mileage for each individual trip is included but I also need to see the total distance for all trips in a report? How do I do this?I didn't receive my domain verification mail
I didn't receive my domain verification mailGet logged in user ID in Deluge script
Hello all, How do I get the id of the logged-in user in a deluge script? the "zoho.loginuserid" function actually returns the users email address or whatever the user id they use to login to zoho with and not the id of the user record, and given thatItem Details Field - New Barcode / Document option?
Is this a new feature??? its in both books and inventory.Shared Mailbox - Mark as read for all users
Hi all, Maybe someone can help me out. At the moment we have a shared mailbox without streams. When a users reads an mail or marks it as read other users will not see this. How can we resolve this? We now archive the mails when read and followed up. HoweverCan I export to PDF in Zoho Learn
I have seen help pages where export to pdf options are available but I do not see that option available from the application. I see that exprt is available in my free trial version but that is only to html pages. I need to be able to export my manualsStaff rules
Hi! Do you people know what are the default staff rules when a new booking is created? We have two staff members in my team (me as the admin, and my employee). As we share the same services, I'm wondering how Zoho will pick the staff for new apointments.Add Image Upload Field to Zoho Bookings Registration Form
Hi, We would like to request the addition of an image upload field to the Zoho Bookings registration form. Currently, Zoho Bookings only supports text-based fields (e.g., Single Line, Multi-Line, Email, Checkbox, Dropdown, Radio Button, and Date), butMerge Tags Output Incorrect Placeholder Text After CRM Sync
Hi everyone, I’m experiencing an issue with merge tags in Zoho Campaigns after last sync of contacts and leads from Zoho CRM (days before everything worked perfectly). Here’s the situation (seems like a default configuration in Campaigns) : My leads haveWindows agent 2025_M02 release notes
Agent Version: 111.0.3.300 Release date: 24 February, 2025 Various Major enhancements to improve overall performance and optimize the user experience. Squashed a few bugs to improve overall product quality.Windows agent 2025_M01 release notes
Agent Version: 111.0.3.299 Release date: 05 February, 2025 Major Enhancement: Live Monitor feature compatibility released. Major Enhancement: Updated Scaling for multi technician cases with Android and Web based viewers. Various other bug fixes and performancehow to record deferred revenue?
Dear Zoho Team, We issue invoices relating to 12-month web hosting service. When we issue the invoice, we should record the entire amount of the invoice as DEFERRED REVENUE (ie. $10 x 12 mths = $120, balance sheet item). After the particular month of the hosting service, $10 of revenue has been earned and deferred revenue amount will be $110. We must keep adjusting the balance sheet and income statement over the course of the service until the company has fulfilled its obligation of services andNarrative 13: Importing your data
Behind the scenes of a successful ticketing system: BTS Series Narrative 13: Importing your data When importing data into an application, it is crucial to prevent data loss or duplication. These types of errors can hinder the development of a clean andBlueprint Not Triggering When Lead Status Is Updated by Workflow (IndiaMART Integration)
I have set up a blueprint that triggers when a lead’s status is “New Lead.” Our CRM is integrated with IndiaMART, and when leads are created from IndiaMART, their Lead Status is initially set to None. To handle this, I created a workflow that automaticallyUpdate Subform in specific field(Status) without affecting other fields in Zoho CRM using Deluge?
Scenario: PRODUCT Module(change name Plot) in any product status change From Available to Booked then on PROJECT Custom Module have Subform So, Subform name is Property Details now in that Subform 1 field is STATUS that update according to product statusYouTube Live #2: Agreement Intelligence with Zoho Sign's eSign AI assistant
Hi there, We're back again with our YouTube live series and this time, we'll take you through our holistic agreement intelligence powered signature workflows. Struggling to draft an agreement? Need help double-checking clauses and going through complicatedCan I Build a POS using ZOHO creator and integrate it with ZOHO Books?
Hello, I have a Zoho Books account and I was wondering if I can have a POS system that integrates with it. Primarily with Inventory, Customers and Payment and ofcourse Create invoices and credit notes. So, would Zoho creator provide me with this solution? Thank you,An important update for Zoho Cliq desktop users
The latest version of the Zoho Cliq desktop app (v1.8.0) will no longer be supported on macOS 10.15 Catalina and earlier versions. This is because the framework we use (Electron) no longer supports some older macOS versions. If you’re using macOS 10.15New Toolbar in Zoho Sheet
We have revamped our toolbar design in this new version of Zoho Sheet. Below are some screenshots to help you get accustomed to this new interface. Click on the picture below to view the animated image in its original size. Scroll down this post to learn about the changes. Highlight of Changes: The previous format tab is now split into 2 tabs - Home and Format. The Home tab contains the commonly used functions and the Format tab holds formatting related options. Under the Home tab towards the farZoho inbuilt Telephony made a lot of issues!
Hi there, I am a user that I am working with zoho inbuilt telephony around 1 month. Non of my colleagues are happy with this app! most of the time customer cannot hear my customer service team, customers say our voice is breaking. whenever Telephony supportSending workflow notifications using popular chat services
Hello everyone, We have introduced instant and scheduled notifications on some of the most popular chat platforms to facilitate easy collaboration, quick action, and wider reach. Workflow notifications can be sent to the following chat platforms: ZohoAdding Images to a Quote in Zoho CRM
We are currently preparing to use Quotes in Zoho CRM and we are building out our Quote templates. We came across an issue of not being to add Images of the products to the Quote - specifically in the body of the Quote templates. This is a problem,Applications built with Zoho Creator
Hi, I’m really interested in seeing how others have built their application using Zoho Creator, especially those designed for external users (clients, vendors, or the public). If you’ve developed something along those lines and don’t mind sharing, I’dIs it posssible to add Asap Widget on Wordpress?
I have tried to add the ASAP widget so users could iniciate chats and see the KB information but nothings seems to work. I have tried to add the script using a php snippet that adds the to the footers and also tried one for the header in the functioRequire ticket resolution
Hi Zoho team, Is there a way to require resolution even if an agent did not use a blueprint? for example, our blueprint has a "resolve" transition but what if agent revoked blueprint and manually set the status of ticket to closed? Is there a way whereTables from ZohoSheets remove images when updated from source
I have a few tables from a ZohoSheet in a ZohoWriter document that will remove the images in the cells when I refresh from the source. The source still has the images in the table when I go to refresh. After updating from the source, as you can see theAPI Pagination Error: 'from' Parameter Limit
Hello, I am encountering an error while paging through the Zoho Desk API results: Status code: 422 - {"errorCode":"UNPROCESSABLE_ENTITY","message":"The value passed for field 'from' exceeds the range of '0-4999'."} Is 5000 the maximum number of recordsNext Page