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
Topic Participants
Anu Abraham
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
Recent Topics
Creating Layout Rule With Formula Field
By The Grace Of G-D. Hi, I see that i cannot use Layout Rules to show/hide Formula Fields. Is that something you plan on adding sometime soon?Combine / merge multiple invoices into master
Good morning Zoho! Upon looking for a solution for my issue, I found many that had my similar problem...dating 13 years ago! Please, any updates on this? Merging multiple invoices on a Master Invoice would alleviate all the extra work of resending andFree Webinar Alert! Productivity Hacks that you don't want to miss on June 24
Hello Zoho Community! Want to work smarter and get more done with Zoho Mail? We’re here to help! Join our interactive webinar to explore powerful Zoho Mail features that can boost your productivity. Watch live demos, learn helpful tips, and take partWeb Clipper cannot save to collections
With the recent update that added collections, i am unable to use the web clipper to save to a collectionsort by name is always z to a
I typically keep my notes in alphabetical order. Suddenly they are all backwards - z to a. They stay that way whether I select a to z or z to a. Is there a way to fix this?Project Management Bulletin: June, 2025
Our project management suite's representatives have been busy socializing with global customers in the USA (Zoholics) and Australia (roadshows). We also had multiple stop overs at our customer’s establishments and were glad to see the efficiency our productsAgenda For Zoholics Benelux & Nordics 2025
Dear Zoho Benelux community, We are pleased to announce the agenda for Zoholics Benelux & Nordics 2025 on September 23-24 at NBC Congrescentrum in Nieuwegein. The topics of the presentations are: Zoho innovations in the region and worldwide The introductionHow to query Deal "Stage" "Is Open" in Analytics SQL?
How do I query this "field" in Analytics? What is going on? It seems like there is another 'mapping' somewhere but that it is inaccessible with raw sql??? If I query "Stage" Like '%Won%' I get a wildly different number than I do when I manually filterEnhanced Candidate Portal: Now Featuring Federated Login, Passwordless Access & MFA
You can now enhance your Candidate Portal experience with Federated Login, Password less Sign-in and Multi-Factor Authentication (MFA). These features offer greater flexibility and control—allowing seamless sign-ins through trusted platforms and addingCustom View and Custom Fields
Hi We have custom fields that we need in the Sales\Customer module and we would like to have the fields available to view in the Bills module so that we can add them to a custom view, is that possible? That way we can look at the Bills screen to see whatCan I write a check in Zoho Books with no associated bill?
This currently does not seem possible, and I have a client that desperately needs this function if I am able to convert them with Quickbooks. Thank you in advance for your reply.Automation#35 : Auto-Add Comments under the Owner's Name in Tickets via Macros
Hello Everyone, This week's custom function provides simple steps to configure a Macro for adding comments to tickets with the name of the Comment owner. When managing tickets, you can use the Comment feature to communicate internally with your team andSubfrom Changes are NOT included in Audit Logs and Timeline
In the Timeline the subform changes are not tracked We have an important custom module for Recording Pricing Information It has a subfrom, now if Changes are made to the subform fields they are not shown in the timeline, ONLY the aggregated fields ThisTracking Emails sent through Outlook
All of our sales team have their Outlook 365 accounts setup with IMAP integration. We're trying to track their email activity that occurs outside the CRM. I can see the email exchanges between the sales people and the clients in the contact module. ButChanging Link Color
When I create a link from a block of text, the text color changes to a color i do not want. After scrolling through the CSS and HTML files I cannot find the setting for the link color. Changing the link color word by word seems inefficient and must be a setting somewhere? Greg Aanes 2109 Queen Street Bellingha WA USAContent Management System
Is there any plan to develop a CMS application that allows us to manage all of the ZOHO services such as Writer, Sheet, and Planner? Besides that, it would be nice to manage the files and logs of WebNMS using SOA. Otherwise i'll try to make it. Thanks, Takash FHow do I pause or halt a running campaign?
Hi, I set up an A/B campaign - and after testing, scheduled the campaign, I noticed an error in the subject line and had to pause or halt the campaign 'mid-flight' - could not find this, and the only option was to delete the entire campaign to halt the send (it was an emergency). Is there a campaign Pause or Stop function/button? I could not find it - am I missing something? (Thank you for your help - I searched the resources and could not find an answer)Contact Segments with multiple CRM modules
Hello, We have a somewhat unique setup in our system involving various components: Contacts, Accounts, Deals, and a couple of custom modules named Properties and Audit Logs. We're looking to implement a notification system via SMS and Email specificallyCannot reorder fields in Page Layout in Expenses and Purchase Requests
It is very inconvenient that the custom fields in Page Layout cannot be re-ordered. The only way is to remove the fields and re-create them; however, it is impractical. This would affect the reports and dashboards we are having. Not able to re-order theHaving issues with creator, flow and calendar
So I have made a creator app when engineer puts in the date and time for when they are going to out on site , this then passes the calendar data to flow and then should populate the inputed data to the calendar. So If use${system.zf_current_date_time}.Problem when forwarding emails
When I want to forward an email received through Zoho, the layout changes: Buttons are cut Pictures change size Text changes alignment (left/right/center) Is this a common problem in Zoho? Thank you, SuzannahView Audit Trail field
The Audit Trail feature is great, but its data is only available to admin users. It would be really great to have a system field "Audit trail" that we can add to the detailed view of a record. This would allow supervisors, directors and etc. to quickly track what changes have been done by whom for each record. It is a current feature from a client of mine and while it's probably possible to hard code it, since this data is already available in Zoho, I would be surprised to hear how hard it wouldRecuring bills payments
I've entered recuring bills that are auto drafted from my account monthly. Can I set up the recuring payment or do I continue to manually do it monthly?Automatically assign Contact Roles to a Deal
Hi guys, Is there a way to assign multiple Contact Roles to a Deal via a workflow or similar? Thankson submit of creator form then record is create in Zoho crm purchase module then on automatically task want to create in the crm
on submit of creator form then record is create in Zoho crm purchase module then on automatically task want to create in the crmZoho CRM Webinar – Automate everything across Customer Journeys in CommandCenter 2.0
How efficient is your current CRM automation setup? As customer journeys become more dynamic, it's common for data and actions to get scattered across teams and modules. This leads to broken processes and inconsistent customer experiences—especially acrossChanging employees email address
How do I change an employee's email address? I am an administrator on the account but it says that I am "not allowed" to do it?MULTI-SELECT LOOKUP - MAIL TEMPLATE
Dear all how are you? We need to insert data from MULTI-SELECT LOOKUP in a email template, but I can't do that, when I'm creating the template I can't find the field to insert it. is there any solution? PVUChanging the owner of a call
Am I correct in my conclusion that I cannot change the owner of a call in Zoho? The field does not show up in the screen, nor can I make it show up as the systems does not give me that option. I cannot "mass update" it either. I tried it, but Zoho refuses to change the name of the owner. Please help out: how do I change the owner of a call.Global Fields
Just like Global Sets for Picklists, we would like to have global fields for any kind of field. Three things that should be saved globally: 1. The Existence of the field 2. The Name and 3. Association with a module should be set up in a respective placeIntroducing Screen Share with Audio
Share your entire screen or just the chrome tab with audio for more engaging presentations. Your audience will hear sound just like you do, whether it's a video, demo or any other content. This is ideal for training sessions, team meetings, and clientNeed Help Preventing Overselling in Zoho Inventory
Hi fellow Zoho Inventory users, I'm reaching out for advice on managing inventory control in our growing business. We've recently encountered situations where sales orders get confirmed despite insufficient stock, creating operational challenges. OurTip #53: Populate and search values from tables using Table Lookup
Qntrl supports tables to store organization-related data and access it easily. Data stored here can be populated and displayed in orchestration using Table Lookups. This helps organizations list sizeable data in dropdown or multiselect dropdown fieldsIntroducing more AES digital signature options in Zoho Sign
Greetings! Zoho Sign has continually strived to partner with trust service providers across the globe to give you complete security and confidence, so you can e-sign documents no matter where you are. We've recently partnered with IgniSign, a trust serviceShuffling between one note to the next
I usually start all my notes per interaction with a contact with the date and then a little detail. But when I search for it it only see a small portion of the note and can't immediately tell which contact its associated with. can we make the note contentImportant Update: TRAI Mandates New SMS Header Format
Hello everyone, We have an announcement regarding a new regulation by the Telephone Regulatory Authority of India (TRAI) that affects all application-to-person (A2P) SMS services. Starting on May 6, 2025, TRAI has mandated that telecom service providersPreview generation in progress for days
I uploaded a video file to Zoho webinar. The file has been showing Preview generation in progress for days. Pls help, why is not approved?Workdrive Upload Notification
Is there a way to be notified when someone externally has uploaded files to a folder? The "Unread" tab is really worthless because it shows all files from every directory on the system. I just need an email (or bell at worst) that says "someone has uploaded into <foldername>".Workflow for "Expenses" module?
Hi there, over the last 2 years, Zoho Expense has seen tremendous growth and we are happy with it. But, sometimes it is frustrating to see things are being implemented halfheartedly, or so it seems. For example, There is the possibility to create workflowsMarkup instead of discount??
Is it possible to have the discount field on an invoice or estimate be a markup instead? It's the very same functionality that I am looking for - to be able to markup an individual item by either a $ or a % and have that cost added (instead of subtracted) to the item cost. Currently, I use the tax feature to accomplish this, but it's very awkward to have "Markup 15%" listed after the subtotal. Plus, if I want to markup items at different rates, I end up with several "markup" lines in the totalsNext Page