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
Feature Request: Ability to copy notecards to Windows desktop
Hello, Please consider adding the ability to copy notecards to Windows desktop. Thanks!Add RSS Feed Feature to Zoho Desk Communities and Knowledge Base
It would be very useful to be able to get updates on content which is relevant to me from Zoho Desk Communities through RSS and also push my own Zoho Desk Community content to other platforms through RSS.Do Individual Forums within Categories, in Desk Community, Produce Their Own RSS Feed?
Do Individual Forums within Categories, in Desk Community, Produce Their Own RSS Feed? If not, can anyone share a work-around that could help me get an RSS feed for individual category forums?Add customer to account based on domain name.
I generate reports based on a the account field, i.e. companyX. In GoToAssist, my last provider, there was an option to automatically assign new ticket creators to a company (or account) based on their domain name. So for example, if a new employee createsZoho One Apps is not populating once clicked
Hi Support, The Apps Menu button (corner right next to my profile) is not loading. It keeps flashing but nothing is showing up. When I type quick in the search bar to locate quickbooks, it continues to flash with no apps shown. ThanksTablet Pencil + Fillable Form
Hi There, I just started using Zoho Writer Forms for our team on iOS. I noticed that some functions support 'scribble' or tablet pens and some do not. Is there a function I am missing where any text field can support 'scribble' or handwriting/printingCRM API v2 AdWords GCLID Parameter
Hi, I'm using AdWords Integration with Zoho CRM using a third party webform and can't manage to insert the "gclid" parameter via Zoho CRM API Leads endpoint (version 2). I already checked the following articles: 1. https://www.zoho.com/crm/help/google-adwords/configure.html#Third_Party 2. https://www.zoho.com/crm/help/api-diff/ Form submission works fine. On server side the gclid is correctly included in API request. The Lead is created successfully. All fields (system and custom) are populated correctlyZoho Writer can be slow to load sometimes
Hello! I've noticed that whenever I restart my web browser (Firefox 2) and try to open Zoho Writer, it always shows the login screen first, even if I have an URL direct to the writing interface itself. I don't recall it doing this in an older version, so why does it happen now? Also, sometimes when starting Zoho Writer, it gets stuck: I see the word "Loading..." come up and the page half-extends but never fully loads. I have to refresh the page totally in order to get it to work properly, but doingMass email processes
Hello, I'm looking to send about 7k emails out. I have them in CSV format with most being people I have previously communicated with. My questions are: * What is the process for using Zoho to send this group of emails out utilizing Microsoft 365 ? I'mZoho WorkDrive 5.0 : d’un outil vers une solution intelligente de gestion de documents
Dans un monde de plus en plus orienté vers les données, les entreprises doivent non seulement gérer une masse croissante de données non structurées, mais aussi en extraire des informations stratégiques. L’intelligence de contenu répond à ce besoin enWeekly Tips: Avoid any email mishaps using Zoho Mail's Email Recall
Let's say you have just sent an important email to a recipient with an important attachment. Moments after hitting send, you realize the attachment is outdated and missing some critical updates. Sending another corrected version of the email without addressingMessaging
Whenever i send a mail to someone, it come with the my name of the company, instead of the name of my company.Can't receive emails. MX Records are good apparently.
Hello, For the past couple of days I have been able to send but unable to receive email through Zoho Webmail. I went into Admin Console and it says: MX Records are configured correctly and Your Domains MX Records are pointed to Zoho. Could you pleaseHow can I customize my sales pipeline in Zoho.com CRM ?
Hi to all intelligent community members I’m Namrata Hinduja Geneva, Switzerland, new member in Zoho.com and in this community. Please resolve my query - How can I customize my sales pipeline in Zoho.com CRM to track the progress of deals more effectively?Error when adding phone number
Hi Team, I'm getting an error when trying to authenticate using my phone, please see image attached. thanks, JoseZoho Projects iOS app update: Revamp of toast message and an option to view the whiteboard images
Hello everyone! In the most recent Zoho Projects app update, we have brought in support for the following features: 1. Toast message revamp: We have enhanced the toast message banners to a bolder interface. You will now be updated on the progress of uploadsSend a new invoice data from Books to local certified solution via API json due local compliance
Greetings, I hope you are doing well and staying safe. Due to local compliance regulations, I am required to issue invoices exclusively using locally certified software, which Zoho Books is not. However, we would like to continue using Zoho Books, soHow to Populate the Amount field of a Deal by subform's aggregate data
https://help.zoho.com/portal/community/topic/custom-function-25-%c2%a0populate-the-amount-field-of-a-deal-by-calculating-the-number-of-related-products-and-its-unit-price I'm trying to do an Deal amount update like this guide but I use a subform to calculate the product amount and price instead. Please help me writing the code. regardsUnblocking Outgoing Emails on exports@carelyexport.com – Urgent Assistance Needed
We are a newly established export-import startup operating under the business name Carely Export, and we are currently using Zoho Mail for our business communications. However, we are experiencing an issue where our outgoing emails are being blocked,Property Management: Creating Amazing Appointment Scheduling Sites
Sometimes a property management company can be very busy where even some time and effort saved can make a difference in a world. If you are a property manager, would you not like it if you could spend the wasted time managing appointments to get your job done? This is where getting a booking appointment platform lets you improve efficiency and save time. The enticing scheduling appointment platform can also help get more clients in than normal. It will help you contend with other companies that haveIP BLACKLISTED UCEPROTECTL3
Your IP 136.143.188.56 was NOT directly involved in aabuse, but has a bad neighborhood. Other customers within this range did not care about their security and got hacked, started spamming, or were even attacking others, while your provider has possiblyAdding Public Holidays to the Calendar
Hi, How do you add a public holiday to the calendar, we are closed on public holidays but if someone has requested holidays over that time how do we avoid the day being deducted as this is already a paid holiday?Your inbox called; it wants less clutter
Inbox full of ghosts? Let Auto-Close do the haunting. Ever stared at your support inbox wondering why half the chats are just… sitting there? No reply, no closure, just hanging like unread messages from a advertising company. Let’s fix that. With Auto-Close,an issue in Zoho CRM where the workflow rule is not triggering
H I’m currently facing an issue in Zoho CRM where the workflow rule is not triggering when a new lead is created through a webform. I’ve double-checked the criteria and field updates, everything seems fine but it still doesn’t fire. Has anyone faced thisFeature Request: Mass update selected Contacts to Accounts
I can't believe this isn't an ability already. It's a quick fix that would save hours of manual entry time. This looks like it had been requested 3-4 years ago with no answers from staff! Please add all contact fields into the "mass update" menu. YouHow to add the other customer to the list of customers
So I have a list of customers with the option of other. So when I select other and the new customer, how to get to it be saved to that list in creator.Automate and Personalize Engagement for Campaign Leads Using Zoho SalesIQ Chatbots
Hi everyone! In our last post, we explored how to identify, qualify, and nurture leads using SalesIQ Triggers and Zoho Campaigns integration. To recap, once visitors meet your criteria, you can add them to a Campaigns mailing list with Triggers. Whencompensation module - salary - No decimals allowed regardless of currency
In the United Kingdom we have calculations in GBP which has figures to 2 decimal points. When using either the basic salary or using the CTC with benefits etc. It will block any upload or entry which is not a round number! I have advised Zoho One andUnable to add estimate field to estimate template
I have the field "SKU" as part of my service data. I can also see it as a column when displaying the list of services. However, I have no way to include it on my estimate template because the field is not showing as a column field to include for the service/partAdding Today's Date into an email template
Is it possible to add today's date into an email template? Any help would be gratefully received.Entry created or updated - not getting all fields
I have a flow that fires on an entry being created or updated in a custom module in CRM. It is only supposed to proceed if a particular field is false and once fired, immediately updates that field to true to avoid running multiple times. For some reason,Help createing Inventory Volume report
I've been working with Zoho support for a few months now trying to develop a inventory volume report. Though they have been helpful, it never seems to generate exactly what we're looking for. I thought I'd turn to the community for further help. We'veZoho Sprints - Timesheet Rejected
Does a user get notified is his Timesheet entry has been rejected?Sixth Insight - The Hidden C in Data
The Wheels of Ticketing - Desk Stories The Hidden C in Data [Importance of clean data] Data cleaning Data cleaning ensures ticketing systems' data is accurate, consistent, and complete. This process includes eliminating duplicates, fixing errors, andSimple Text Search Function
Would it be too much to ask for a simple text search function? My slide decks are often simply collections of slides of a random over, and I often have to find the slide I need at a moment's notice. A text search function, no matter how rudimentary, wouldKPI Widget would not load columns
My Zoho Analytics would not load columns on KPI Widgets, is there anyone who could help me on this?Introducing the calendar view for Bigin's Activities module
Hello everyone, We're excited to announce the calendar view in Bigin. This view presents all tasks, events, and calls in an intuitive and visually appealing interface, and will be set as the Activities module's default landing page, ensuring you haveAdd documents/uploaded files in Zoho CRM records that can be accessed by all team members?
Hi, I'm building out our small business' Zoho CRM implementation and are on a Zoho One plan. We do LED Lighting Projects for customers, and collect data like customer utility bill PDFs, and pictures of existing lighting that we want to keep in one centralizedCustomizing Helpcenter texts
I’m customizing the Zoho Desk Help Center and I’d like to change the wording of the standard widgets – for example, the text in the “Submit Ticket” banner that appears in the footer, or other built-in widget labels and messages. So far, I haven’t foundZoho Desk - I am no longer receiving email notifications when comments are made on tickets
I still receive other notifications via email (e.g., new tickets and replies) - however beginning May21, I no longer receive notifications on comments (whether private or public) - I have confirmed that notifications are toggled on for agents within system/notificationNext Page