Kaizen 215 - Workflow APIs - Part 3
Welcome back to another week of Kaizen!
Over the last couple of weeks, we’ve joined Zylker Cloud Services as they review and improve their workflows. In Part 1, we discovered and audited their sprawling workflow landscape. In Part 2, we learned how to use the Configuration API to understand valid triggers and actions, preventing errors before they happen.
Now, it is time to take action. Zylker has identified the "VP Alert - High Value Deal" workflow as a prime candidate for an update. It is old, has never run, and its logic might be too narrow. We will also explore how to create a new workflow from scratch to handle a new business requirement.
STEP 5: Update an Existing Workflow
From our audit in Step 2, we know that the existing ‘VP Alert - High Value Deal’ workflow (id: 4876876000016390024) hadn’t triggered even once. The original $50,000 threshold missed many valuable deals. Most winning opportunities actually land above $30,000. It has never executed, suggesting the criteria are too strict.
Let us use the Update Workflow Rule API to fix it. We'll change the criteria to trigger for deals greater than or equal to $30,000 and add an additional email notification.
What you can and cannot update
When working with the Update Workflow Rule API, not every field in a workflow is open for modification. Think of it like editing an existing automation blueprint. Some foundations are fixed, while others are flexible.
You can update:
Name and Description
Trigger : You can update triggers, but only within the same trigger type. For example, you can change a Record Action trigger from create to edit, but not from a Record Action trigger to a Score-based trigger. For more details on this, please refer to our detailed help documentation here.
Conditions and Criteria : add, remove, or refine them.
Actions : add new ones, remove existing ones, or update their configuration.
Status : activate or deactivate a workflow rule.
What cannot be updated
There are a few key restrictions to remember:
You cannot change the module associated with the workflow.
You cannot switch trigger categories (e.g., from Record Action to Email Trigger).
You cannot retain unsupported actions when changing to a trigger that doesn’t support them. For instance, if you change a trigger from Edit to Delete, but keep an Assign Owner action, the update will fail, because “Assign Owner” isn’t valid for Delete triggers.
Updating an existing workflow is not about replacing everything. it is about editing precisely what needs to change.
Here is how to do it:
Fetch the workflow details using the Get Workflow Rule API. This gives the full structure, including condition IDs, action IDs, and trigger details.
Identify what needs to change.
In this case, to fix the “VP Alert - High Value Deal” workflow, we can update the Workflow rule to:
lower the threshold to $300,000
change the comparator to greater_than.
To make the workflow more useful, Zylker has also decided to add a few new actions.
But before doing that, the developers needed to confirm which actions are supported for this workflow’s trigger type. That is where last week’s Configuration API comes in handy. Since we already know this is a Record Action trigger (create_or_edit), we can refer to the configuration response we explored in Part 2 to see which actions are valid.
{ "api_name": "create_or_edit", "deprecated": false, "name": "CreateorEdit", "scheduled_actions_supported": true, "actions": [ "field_updates", "assign_owner", "add_tags", "remove_tags", "email_notifications", "tasks", "create_record", "create_connected_record", "add_meeting", "webhooks", "functions", "circuits", "flow" ] }, |
The response clearly shows that email notifications, field updates, and tags are all supported for this trigger type. With that confidence, in addition to updating the condition, we can also add a 'Priority' tag to those records that trigger the Workflow. This makes the workflow more visible and actionable across the sales hierarchy.
Sample Request:
PUT {{api-domain}}/crm/v8/settings/automation/workflow_rules/4876876000016390024
{ "workflow_rules": [ { "description": "Notify sales leadership and track strategic opportunities", "name": "VP Alert - High Value Deal.", "conditions": [ { "sequence_number": 1, "criteria_details": { "criteria": { "group_operator": "AND", "group": [ { "comparator": "greater_than", // change in comparator operator "field": { "api_name": "Amount" }, "value": "300000" // Lowered threshold }, { "comparator": "equal", "field": { "api_name": "Stage" }, "value": "Negotiation/Review" } ] } }, "instant_actions": { "actions": [ { "type": "add_tags", "module": "Deals", "details": { "tags": [ { "name": "Priority" } ], "overwrite": true } } ] }, "id": "4876876000016390025" // id of the condition to be updated } ] } ] } |
After this update, the workflow now triggers for any deal worth more than $300,000 in the Negotiation/Review stage. Apart from sending the email notifications and adding the follow up task, it also tags these deals as Priority.
Edit vs Add:
To edit an existing condition or action, include its existing id in your update payload. Zoho CRM will recognize it as an update to that object.
To add a new condition or action, simply omit the id. CRM treats any object without an ID as a new addition.
STEP 6: Create a new Workflow Rule
With the “VP Alert - High Value Deal” workflow now fixed and performing as expected, Zylker’s sales team quickly began to see results.
But their sales team noticed that deals often stall after proposals are sent, with no systematic follow-up. Zylker has hence refined the requirements for a new Workflow.
They want to automatically trigger follow-up actions when a high-value deal (above ₹30,000) is marked “Closed Lost” due to pricing reasons. This workflow must ensure that every lost opportunity is reviewed, tagged, and re-engaged after a cooling-off period. To achieve this, they want to create a workflow to be triggered whenever a deal’s Stage is updated to Closed Lost. It must perform the following actions:
Add tags Lost due to Pricing and Re-engagement Pending.
Send an email alert to the Sales team, with the details of the failed Deal, so they can look into the reasons.
After 30 business days, automatically create another “Lost Deal - Feedback” task to remind the owner to re-contact the customer for feedback, and for future opportunities.
Before proceeding, Zylker makes an API call to the Workflow Configuration endpoint. This ensures that their chosen trigger type and actions are supported. From the response snippet below, it is clear that a field_update trigger supports scheduled actions and the required action types.
{ "api_name": "field_update", "deprecated": false, "name": "FieldUpdate", "scheduled_actions_supported": true, "actions": [ "field_updates", "assign_owner", "add_tags", "remove_tags", "email_notifications", "tasks", "create_record", "create_connected_record", "add_meeting", "webhooks", "functions", "circuits", "flow" ] } |
With these details validated, we can now move on to adding a new workflow for Zylker using the Create Workflow Rule API request.
Understanding the input JSON structure
Every workflow definition follows the same hierarchy - defining when the rule runs, what conditions it checks, and which actions it performs.
The top-level input object contains a workflow_rules array. You must include just one workflow rule object per request. Each workflow rule defines its name, trigger type, and one or more condition blocks, each with its own criteria and actions.
Here is a breakdown of what is inside a single workflow rule:
{ "workflow_rules": [ { "name": "VP Alert - High Value Deal.", //name of the workflow rule "description": "Notify leadership when high-value deals are lost due to pricing.", "module": { "api_name": "Deals" }, //module to which the workflow applies "execute_when": { ... }, //trigger configuration (e.g., on record edit, field update, etc.) "conditions": [ { "sequence_number": 1, // order of execution. this is the first condition "criteria_details": { ... }, // condition logic (criteria group) "instant_actions": { "actions": [ ... ] }, //instant actions executed instantly cheduled_actions": [ // schedules actions executed after a delay { "execute_after": { ... }, // delay period for the scheduled action "actions": [ ... ] } ] }, { "sequence_number": 2, // second condition "criteria_details": { ... }, "instant_actions": { "actions": [ ... ] } } ] } ] } |
Associative vs. Non-Associative Actions
Every workflow rule performs one or more actions like sending an email, creating a task, or updating a field, etc. These actions fall into two broad categories: associative and non-associative.
Type | Description | Example Actions |
Non- Associative Actions | These are defined inside the workflow rule itself. They do not need to exist beforehand. You can configure their details directly within the workflow payload. | Create record, schedule a call, add a meeting, convert records, social actions, create record on email received, assign owner, |
Associative Actions | These are reusable actions created separately in CRM and referenced by their IDs. They can be used across multiple workflows and other automation tools. | Field updates, Email notifications, tasks, Webhooks, Add/Remove tags |
When you create or update a workflow via API, the associative actions require you to pass their existing action IDs. These IDs can be fetched using the corresponding Actions APIs : Field Updates, Email Notifications, Webhooks, and Tasks. In the coming weeks of Kaizen, we will take a closer look at each of these Actions APIs. We will see how to create, manage, and delete them within your workflow automation strategy.
Sample Request:
POST {{api-domain}}/crm/v8/settings/automation/workflow_rules
{ "workflow_rules": [ { "execute_when": { "details": { "trigger_module": { "api_name": "Deals", "id": "4876876000000002181" }, "criteria": { "comparator": "equal", "field": { "api_name": "Stage", "id": "4876876000000002565" }, "type": "value", "value": "Closed Lost" }, "repeat": false, "match_all": false }, "type": "field_update" }, "module": { "api_name": "Deals", "id": "4876876000000002181" }, "description": "Triggers tasks, tags, and follow-up reminders for high-value deals lost due to pricing", "name": "Lost Deal due to Pricing - Follow Up", "conditions": [ { "sequence_number": 1, "instant_actions": { "actions": [ { "name": "Lost Deal - Feedback", "id": "4876876000016794047", "type": "tasks" }, { "details": { "module": { "api_name": "Deals", "id": "4876876000000002181" }, "over_write": false, "tags": [ { "name": "Lost due to Pricing", "id": "4876876000016794071", "color_code": "#658BA8" }, { "name": "Re-engagement pending", "id": "4876876000016794075", "color_code": "#879BFC" } ] }, "type": "add_tags" }, { "name": "Deal Lost Alert", "id": "4876876000016794062", "type": "email_notifications" } ] }, "scheduled_actions": [ { "execute_after": { "period": "business_days", "unit": 30 }, "actions": [ { "name": "Lost Deal - Feedback", "id": "4876876000016794047", "type": "tasks" } ] } ], "criteria_details": { "criteria": { "group_operator": "AND", "group": [ { "comparator": "greater_equal", "field": { "api_name": "Amount", "id": "4876876000000002557" }, "type": "value", "value": "30000" }, { "comparator": "equal", "field": { "api_name": "Reason_For_Loss__s", "id": "4876876000002440001" }, "type": "value", "value": "Price" } ] } } } ] } ] } |
The execute_when defines when the workflow should fire.
type = field_update means this rule runs when a field’s value changes.
criteria : Stage = Closed Lost so the rule triggers whenever the Stage field is updated to Closed Lost.
repeat = false ensures it will not trigger multiple times for the same record.
In simple terms: “Whenever a deal is marked as Closed Lost, run this workflow.” The criteria_details section refines the trigger. The workflow only runs when the Amount ≥ ₹30,000 AND Reason for Loss = Price.
The instant_actions section inside the conditions array has the actions to be executed immediately when the criteria are met.
Add Tags : labels the record for easy filtering and reporting.
Send Email Alert : notifies the sales team instantly about the lost deal.
The scheduled_actions defines what happens after some time has passed. In this case, after 30 business days. Here, the workflow automatically creates a “Lost Deal - Feedback” task, reminding the deal owner to follow up with the customer to get feedback, and for future opportunities.
- The Amount is greater than or equal to ₹30,000, and
The Reason for Loss is “Price.”
By combining these elements, this workflow achieves a full closed-loop follow-up system.
Conclusion:
Zylker’s updated and new workflows make their automation smarter and more responsive. They are now able to spot key deals and ensure lost opportunities are revisited.
We hope you are now well on your way to mastering Workflow APIs. Share your thoughts in the comments or write to us at support@zohocrm.com.
Additional Reading:
- Workflow APIs - Part 1 - Auditing Workflows
- Workflow APIs - Part 2 - Find out what actions and triggers are supported for each module
Access your files securely from anywhere
Zoho FSM Video Tutorials
All-in-one knowledge management and training platform for your employees and customers.
Zoho Developer Community
Topic Participants
Anu Abraham
Sticky Posts
Announcing the new SKILL.md for Zoho CRM and the updated OAS repository!
We are introducing a new zoho-crm skill to make working with Zoho CRM Developer tools (like APIs, functions, widgets, client scripts, queries etc) easier and faster, with the help of AI in your preferred AI harness like Claude Code, Codex, Cursor, VSCodeKaizen #261 : Using Zoho CRM Skill to generate complex COQL queries
Hello everyone, In the previous Kaizen posts, we introduced the zoho-crm SKILL.md and discussed how it can help you when you are working with Zoho CRM APIs and Client Script. In this Kaizen, we will focus on using the Zoho CRM `SKILL.md` with GitHub CopilotKaizen #256 - Build an Arrival Readiness Web Tab in Zoho CRM
Hi everyone! Welcome back to the Kaizen series! In the post, we discuss a use case in hospitality industry: how an Arrival Readiness web tab widget can be used to let reception staff identify and resolve issues before arrival of guests. Use case In theKaizen #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 this
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Billing 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.
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
Alias Email Id already exists
Hi, I just verified my domain sesque (dot) com and now I am trying to create the admin account using admin (at) sesque (dot) com, but I am getting an error saying "Alias Email Id already exists". I used to have another Zoho account with this email address,Allow widgets to be placed between native sections in the Ticket Properties panel
One of our biggest frustrations with the Tickets module is how rigid the Ticket Properties panel is. Every section there is built only from native Zoho Desk fields. We can add sections, rearrange fields, and pick layouts, but we can’t put anything customShow backordered items on packing slip
We send out a lot of large orders, and often there are one or two things backordered. How can I fix the packing slips to show quantity ordered & quantity packed There should also be the ability to "ship" 0 of an item so the receiver knows that thingsDeleted Module
I accidentally deleted a module and its fields. Im trying to get it back. Thanks to Youtubers flooding the internet with out of date videos I can't find how to get deleted modules back. The Recycle Bin doesn't have modules. Anyone know how to do thiSet department automatically for incoming calls
Is it possible, when receiving an incoming call through Zoho Desk (using Twilio integration), for the department to be auto-selected based on the phone line being called? Currently, we have to manually select the department from the dropdown menu whenMake better hiring decisions with Compare Applications and Zia Insights (Beta)
When multiple candidates apply for different job openings, evaluating each application against the right job requirements can take time. Reviewing resumes, candidate details, and interview feedback separately can make it harder to assess role fit andSupport Plan: Recuring Issue
Hi Zoho Team, Could you please look into this recurring alert and provide clarification on why this restriction is still in place? This issue has become a bottleneck in our workflow, significantly limiting our automation capabilities. We are unable toMultiple criteria in searchRecords
Hi, is it possible to search with multiple criteria in zoho.crm.searchRecords? I have tried several variations of the following without much success. CustomerRecord = zoho.crm.searchRecords("Contacts", "(First Name|=| lee)" && "(Last Name|=| spencer)"); Thanks. ChrisCreating packages according to actual shipping processes
Hi community. I would like to ask a question to see if there's a better method or workflow for the creation of packages in Zoho Inventory. There is a little confusion in some of Zoho's language relating to the use of term Packing Slip when connected toZoho Webinar - Sharing System Audio (NOT AVAILABLE)
Hi, We are having a serious problem with Zoho Webinar. In the webinars we run, we very often share the audio from a video we are streaming directly from YouTube or other applications. Until recently we were using Zoom, but as we use other Zoho applicationsAd-hoc approvals are now available in CRM approval processes
Released for all DCs. Hello everyone, We've introduced ad-hoc approvals in CRM approval processes. This enhancement lets approvers add additional approvers when needed, without changing the configured approval workflow. How the approval process worksIntroducing PRM: Build, manage, and scale your partner ecosystem
Growing a partner ecosystem is a good problem to have. What starts as a handful of partners can quickly turn into a maze of spreadsheets, emails, and disconnected processes. More partners mean more opportunities, greater reach, and new ways to growData Subject Requests in Zoho Mail: Retrieve and export email data for legal and compliance needs
Organizations are often required to retrieve specific email communication data in response to legal investigations or compliance audits. The Data Subject Requests (DSR) feature in the Zoho Mail Admin Console allows administrators to search for all emailIntroducing live chat for Zoho CommunitySpaces
Hello everyone, We’re happy to announce that your community members now have a direct line to you. Zoho CommunitySpaces now has a live chat widget, powered by Zoho SalesIQ, so a member can open a chat from your community and get a quick one-to-one answerMoving software
I need someone to customize zoho for my moving business I need to do the following . 1. Quote comes in from ezemove website or we enter customer details into the system 2. Email quote to customer based on hourly rate 3. Customer accepts quote deposit is taken 4. We convert the quote into a confirmation email and add job to the diary and assign resources to the job 5. Job gets completed and we enter invoice amount into the system and email the invoice Budget : neg | Duration : 1 month To leave a privateHow To Create a Report with Subforms from Two Modules
I want to create a report based on data in subforms over 2 separate modules. Can this be done? I tried to do it in Analytics, but one is a date field that needs to be grouped by month, and it doesn't look like Analytics can do this.Introducing Zoho Commerce 2.0 — It's more than just selling!
Hello! We are proud to launch Zoho Commerce 2.0, a reimagination of how online businesses look, feel, and function. This launch is both timely and symbolic, as we reaffirm our commitment to empowering small and medium enterprises with powerful, yet simple-to-useDomain sparkylab.co.kr still linked to an old Zoho account after ownership verification - release pending 2+ days
Hello Zoho team, I own the domain sparkylab.co.kr (registered and managed through Gabia, a Korean registrar) and I am trying to add it to my own Zoho organization (SparkyLab) on the Forever Free plan. When I add the domain at mailadmin.zoho.com/hosting?plan=free,Vendor payment unexpectedly routed through Prepaid Expenses instead of Accounts Payable
Hello, We are investigating an unexpected accounting behavior in Zoho Books. We created vendor bills and vendor payments for two suppliers using what appears to be the same workflow, but the journal entries are different. Vendor 1 – UZ Store (works correctly)What's New in Zoho Billing | September 2026
September brings new capabilities to Zoho Billing across subscriptions, payments, reports, and the product catalog. From managing subscriptions through the Play Store and App Store to setting usage limits for Hosted Payment Page links and configuringColumns in Reports Showing Count instead of Amounts
I have a table in a modular where we can add our bill claims. I want to show these in the attached table. The dates are right, but they are grouped by Row Count. I want the amounts showing where the row count numbers are. Anyone know how to do this? IWidget Height were destroyed
All widget heights in the Details Canvas view are broken. Moderation Update: This issue with widget heights in Client Script popups and flyouts has been resolved. Widgets should now display at their expected heights.Zoho Mail iOS app updates - Shared Mailboxes, Calendly Integration and other enhancements
Hello everyone! We're excited to announce the features and enhancements available for the Zoho Mail iOS app. Shared Mailboxes and Calendly integration are now available in the Zoho Mail iOS app, along with a few other enhancements. Let's dive into theZoho Extensions 101: Building extensions for Zoho People
Hello developers! Welcome to our new video series on building extensions for Zoho People! If you're new to extension development or looking for guidance on building extensions for Zoho People, you're in the right place. We've curated a series of videosTags on individual ticket comments and replies, with color coding and a filter
In Zoho Desk you can tag a ticket, but you can’t tag the individual comments and replies inside it. For teams with long, structured ticket threads, that’s a big gap. The problem Our tickets can easily reach 50+ comments and replies. Many of them are specific,Merge Tickets Directly from Contact Page in Zoho Desk
Dear Zoho Desk Support Team, We are writing to request a new feature that would allow users to easily merge tickets directly from the contact page in Zoho Desk. Currently, the only option to merge tickets is from the Tickets list view page, which canGrassHopper VOIP Integration
Does Zoho Plan to integrate with Grasshopper to allow the Telephony hookup in Zoho Desk? If not, Can this be passed along for considerationSharing View Only Portal
Im looking at Youtube videos on how to share a view only link to my projects. Everyone has the screen with Manage Users. I don't have it. Is that an old version or new version? I can't see how to send a view only link to clients. There is a Profiles andHow Do I Refund a Customer Directly to Their Credit Card?
Hi, I use books to auto-charge my customers credit card. But when I create a credit note there doesn't seem to be a way to directly refund the amount back to their credit card. Is the only way to refund a credit note by doing it "offline" - or manually-Enhancement Request – Allow cashiers to collect payments and partial payments for outstanding credit invoices directly from Zoho POS Billing App
We are testing Zoho POS for a retail business with multiple physical stores and have identified an important limitation in the cashier workflow. When a sale is completed using Credit Sale, Zoho POS correctly creates an unpaid invoice and the outstandingHow Can I Collect Payments for Credit Sales Directly from Zoho POS Billing App?
We are currently testing Zoho POS for a retail business and have encountered an issue with collecting payments on outstanding invoices from customers who purchase on credit. When we process a Credit Sale, Zoho POS correctly creates an Unpaid Invoice.Zoho POS Mobile Sales Price Conflicts & Pricing Discrepancies
We are seeing recurring Zoho POS Mobile conflicts tied to the Sales Price field, even though drivers are not manually changing item pricing. We have also noticed small price differences between POS transactions and Books, sometimes only a few cents. DevicesCreator -Dynamic addition of Customer Portal User Licenses
Hi, We have a Creator App for B2C about to get released. We are experiencing the Portal User license challenge. Unable to predict the number of users who will download and Subscribe. When a User is about Subscribe and the portal licenses does not exists,Reminder Settings - Time Tracker
On the time tracker in Reminder Settings I created a reminder according to the Zoho manual. But a manager asked me to change the message that goes in the email. Is it possible to change the message? I didn't find that in the Zoho manual. Another question: I configured to receive the reminder everyone who logged in less than 40 hours. Does Zoho consider less than 40 hours of the current week or the whole month? Another situation, I put it so that I and another specific user would receive the notification,New in Cadences: WhatsApp follow-ups, upgraded limits, and options for add-ons
Hello everyone, We're rolling out two key updates to help you engage better and scale smarter with Cadences in Zoho CRM. Reach customers on WhatsApp, directly from Cadences Previously, Cadences have enabled you to automate follow-ups through emails, calls,Specific ListView Canvas on Canvas Home Page Always Loads Most Recent ListView, Not the One Specified
I had mentioned this to ZOHO, but I mainly wanted to see if others in the Community are also facing this problem. I created a Canvas ListView for a Custom Module, and then created a Canvas Home page (technically on a tab item, but I'm not sure if thatThis user is not allowed to add in Zoho. Please contact support-as@zohocorp.com for further details
Hello, I am the Super Administrator of the Zoho Mail organization for carrytrail.com. The domain has already been verified, but when I try to create the user. I receive the following error: “This user is not allowed to add in Zoho. Please contact support-as@zohocorp.comTip #92 – Organize your support operations with Departments – ‘Insider Insights’
Hello Zoho Assist Community! As a support team grows, so does the complexity. Different customers, different products, technicians spread across regions, and each group needing its own way of working. When everyone operates from a single shared space,Introducing Zoho Office Desktop
Hi users, We are excited to announce Zoho Office Desktop, a single app to install, update, and open Zoho Writer, Sheet, Show, and PDF Editor on Windows and macOS. It includes: One home for every app: Choose the apps you want, and a guided installationHow Can You Find Broken Internal Links Without Checking Every Page Manually?
Broken internal links are a common technical SEO issue. They can send visitors to missing pages, interrupt navigation, and make website maintenance more difficult. On a large website, checking every link manually is simply not practical. So, how can youNext Page