Kaizen #33 - Triggering Workflow Rules, Approvals, and Blueprints via Zoho CRM API
Hello everyone!
Welcome back to yet another post in the Kaizen series.
This week, we will discuss Triggering Workflow rules, Approvals, and Blueprints via Zoho CRM API, while inserting, updating, or upserting records.
First things first—What are Workflows, Approvals, and Blueprints?
- Workflow Rules: Using workflow rules, you can automate a set of routine actions and communication like sending email notifications, assigning tasks, field updates, and so on.
- Approvals: Using the approval process, you can automate the process of submitting records for approval based on certain conditions, and define the set of actions to be performed upon approval or rejection of the record.
- Blueprints: Blueprints are a replica of your business process. They facilitate automation, validation, and collaboration of teams, thus making your business process more efficient and free from loopholes.
The default flow:
- While creating/updating/deleting records via API, you need not explicitly specify any input to trigger workflow rules, approvals, or blueprints. When the records match the criteria, the automation rules will be triggered automatically.
- When you specify an empty "trigger" array in the input, the system prevents the execution of all automation rules (workflow rules, approvals, and blueprints)."trigger":[]
- To trigger a specific set of automation (workflow rule, approval or blueprint), you must specify the value in the "trigger" key of the input. For instance, to trigger all the workflow rules and approvals, but not blueprints associated with the request:"trigger": ["workflow","approval"]
Example:
Zylker Inc. is a sales organization that provides multiple B2B solutions. Let us see how Zylker Inc. manages various business scenarios using workflow rules, approvals, and blueprints.
1. Triggering workflow rules
Assume that to avoid delayed closings, Zylker Inc., has decided to close deals with value 2000 or more, within a week of their initiation.
To manage this, they have a workflow that automatically assigns a task to the deal owner to close the deal within a week, when a new deal with amount greater than or equal to 2000 is created.
Here is a screenshot of a sample deal that meets the above mentioned condition, created via API.
You can see that a new task is automatically assigned to the deal owner to close the deal within a week.
1a. To prevent the system from triggering workflow
Now, assume that a deal is already closed and won, and you are creating it in Zoho CRM for record purposes. In this case, there is no need to assign a task to the deal owner to close the deal within a week.
Hence, to prevent the system from triggering the workflow, you must specify the "trigger" key in the input with no values. The sample input would be:
{ "data": [ { "Deal_Name": "Sample Deal3", "Pipeline": "Standard", "Stage": "Qualification", "Amount": "6000" } ], "trigger": [] } |
1b. To trigger all the workflow rules (but not approvals or blueprints)
To trigger all the workflow rules associated with creating a deal, and prevent the system from triggering any other automation rule (approvals or blueprints), the input would be:
{ "data": [ { "Deal_Name": "Sample Deal3", "Pipeline": "Standard", "Stage": "Qualification", "Amount": "6000" } ], "trigger": [ "workflow" ] } |
The "wf_trigger" parameter for Delete Records API
You can use "wf_trigger" parameter to trigger the workflows/prevent the system from triggering workflows while deleting records. The parameter accepts boolean values, with default value false.
Sample request to trigger workflow while deleting records:
curl "https://www.zohoapis.com/crm/v2/Leads?ids=410405000002264040,410405000002264025&wf_trigger=true" -X DELETE -H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf" |
2. Triggering approvals
Assume that as per Zylker Inc's policies, the sales representatives are allowed to give a discount of up to only 10% during the negotiation stage of a deal. If they have to give a discount beyond 10%, they must get approval from their manager and their sales director. Based on the deal size and purchase history, the approvers would choose to approve or reject the discount requested by the customer.
To manage this, they have configured an approval process that automatically submits the deals for approval, if the discount is more than 10%.
Here is a screenshot of a sample deal that meets the above mentioned condition, created via API.
You can see that the record has been automatically created in the approval mode.
2a. To prevent the system from triggering the approval process (while allowing it to trigger workflows)
While the above mentioned flow is default, there is a catch—when the deal amount is more than a specific limit, the restrictions on discount can be relaxed by sales representatives themselves.
In this case, there is no need to submit the records for approval. However, the workflow rule must be triggered to create a task for the deal owner to close it within a week.
The sample input to trigger all the associated workflow but not approval processes would be:
{ "data": [ { "Deal_Name": "Sample Deal3", "Pipeline": "Standard", "Stage": "Qualification", "Amount": "6000" } ], "trigger": [ "workflow" ] } |
2b. To trigger all the approval process (but not workflows and blueprints)
To trigger all the approvals associated with creating a deal, and prevent the system from triggering any other automation rule (workflows or blueprints), the input would be:
{ "data": [ { "Deal_Name": "Sample Deal3", "Pipeline": "Standard", "Stage": "Qualification", "Amount": "6000" } ], "trigger": [ "approval" ] } |
If you specify "approval" and "workflow" in the "trigger" array, the system triggers all the approval processes and workflow rules associated with the request.
3. Triggering a blueprint
Assume that Zylker Inc follows a simple deal follow-up process. Whenever a new deal is created, it goes through a few stages like Qualification, Negotiation, Discount Approval, Contract, and Deal Closure. To manage the same, they have configured a blueprint.
In any case, if you do not want the record action to trigger the blueprint, the sample input would be:
{ "data": [ { "Deal_Name": "Sample Deal3", "Pipeline": "Standard", "Stage": "Qualification", "Amount": "6000" } ], "trigger": [] } |
If you specify an empty "trigger" array the system prevents the execution of any automation rule associated with the request. Instead, if you specify "blueprint" in the "trigger" array, all the blueprints associated with the request will be triggered by the system.
We hope you found this post useful. Reach out to us at support@zohocrm.com if you have any questions, or let us know in the comment section.
We will meet you next week with another useful topic.
Cheers!
Next 'Kaizen' - API Credits
Access your files securely from anywhere
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Sneha Sridharan
chaitanya2561
Praveen Sankar
Sticky Posts
Kaizen #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 theKaizen #197: Frequently Asked Questions on GraphQL APIs
🎊 Nearing 200th Kaizen Post – We want to hear from you! 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 #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.
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
Payment on a past due balance
Scenario: Customer is past due on their account for 4 months. We suspend their billing in Zoho books. Customer finally logs into the portal and enters a new credit card. We associate that cardwith their subscription, which will permit the card to be usedHow to export all line-item descriptions for a specific item in Zoho Books?
I am trying to audit a specific item (“Item X”) that has been invoiced multiple times with different line-level descriptions. Here’s the situation: I am using Zoho Books (Professional). Each invoice may contain the same item but with different descriptionsList of hidden features
Hi Friends, I had another support chat today and low and behold the feature that I wanted just simply needed to be "enabled". I thought I'd share, and maybe see if others had some similar experiences. 1. This one is from 5 ish years ago. I asked if thereHow to change a BAS that has been filed
I have discovered that a group of expense transactions were accidentally placed in a asset account rather than an expense account. As a result I need to adjust the transaction and consequently most of my BAS to correct the error. Because the BAS haveHow to Export PDF with a custom Template
I need to export Sales Order with a Custom Template I have created How can I do it? I see an API to export the PDF but how can I choose which template to choose to generate the PDFAssociate email with a potential or project.
I have a pivotal requirement to associate emails from various suppliers (contacts) with different potentials or projects, on an email by email basis as they come in. This question appears to have been raised before but I cannot find a definitive yes "it can be done". Could anyone please tell me, yes or no. If the later I can stop wasting time and look at alternative crm systems. I would love not to have to do this. Thanks in advance.MTA - BAD IP reputation by outlook/hotmail
Messages to Microsoft email servers are bouncing back due to poor reputation. Message: 4.7.650 The mail server [136.143.188.206] has been temporarily rate limited due to IP reputation. For e-mail delivery information see https://postmaster.live.com (S775)Function with Search Records was working until a few weeks ago, around when "Connected Records" was released
I have a custom function that has been running for nearly a year now, which suddenly stopped working around the time Zoho released the "Connected Records" update. The function is no longer finding the record using the searchRecords function. I've changedIs CRM On Premise available
Hi Zoho team, Can you please let me know that CRM Zoho is available for On Premise as well? Thanks, DevashishHow to sync from Zoho Projects into an existing Sprint in Zoho Sprints?
Hi I have managed to integrate Zoho Projects with Zoho Sprints and I can see that the integration works as a project was created in Zoho Sprints. But, what I would like to do is to sync into an existing Zoho Sprints project. Is there a way to make thatOnline Assessment or any aptitude test
This video is really helpful! I have one question — if I share an assessment form link (through email or with the application form on my career page), how does Zoho Recruit evaluate it? Can a candidate use Google or external help while taking the test,Editing the Ticket Properties column
This is going to sound like a dumb question, but I cannot figure out how to configure/edit the sections (and their fields) in this column: For example, we have a custom "Resolution" field, which parked itself in the "Ticket Information" section of thisIncoming Threads Report
From data to decisions: A deep dive into ticketing system reports Customers raise questions and issues through multiple channels, such as email, chat, or tickets. To monitor the number of queries received on a specific day from each channel, leads canConditional layouts - support for multi-select picklists
Hi, The documentation for conditional layouts says the following: "Layout Rules cannot be used on the following field types: Auto Number Lookup Multi Select Lookup User Lookup Formula File Upload Multi Line" I have a custom module with a multi-pick listSamsung Keyboard Issues with Notebook
Dear Users, We're sorry to inform you that some of our users are experiencing certain issues like scrolling, delay/lag, cursor placement especially within the text notes. This occurs mainly due to Samsung Keyboard compatibility with Android 13 and someHow to apply customized Zoho Crm Home Page to all users?
I have tried to study manuals and play with Zoho CRM but haven't found a way how to apply customized Zoho CRM Home Page as a (default) home page for other CRM users.. How that can be done, if possible? - kipi Moderation Update: Currently, each user hasCloudflare Turnstile is now available in Zoho Forms!
Hello form builders! We have added a new layer of protection to help you keep your forms free from bots. Instead of forcing users to prove they are human, Cloudflare Turnstile quietly checks browser signals in the background. Your real users glide through,Power of Automation :: Unique Task & Issue Prefix Format and Sequencing Rule
Hello Everyone, A custom function is a software code that can be used to automate a process and this allows you to automate a notification, call a webhook, or perform logic immediately after a workflow rule is triggered. This feature helps to automate【Zoho CRM】キャンバス機能のアップデート
ユーザーの皆さま、こんにちは。コミュニティチームの藤澤です。 今回は「Zoho CRM アップデート情報」の中から、キャンバス機能のアップデートをご紹介します。 目次 グリッドについて フォーム表示のタブについて 1. グリッドについて ビジュアルデザインは細部の調整に手間がかかりますが、キャンバスのグリッドを使えば要素を整理し、バランスよく配置できます。 画像やデータなどの要素をグループ化せずに簡単に配置できます。 余白を調整することで、要素間の視覚的なバランスを保つのに役立ちます。 「表示切り替え基準の幅」を設定すると、デザインをレスポンシブに調整できます。Deleting unwanted ticket replies
Hello, In a Zoho Desk Ticket thread, sometimes one of the recipients has auto-reply activated. This creates a new message in the Ticket thread that not only pollutes the thread, but most importantly cannot be replied properly because usually auto-reply e-mails don't do "reply all", so the other recipients are not included. I want to delete such a message in the Ticket thread. I searched the help of Zoho Desk, but only found a way to mark as Spam (https://help.zoho.com/portal/kb/articles/marking-support-tickets-as-spam)Issue: Ticket Export Does Not Include Ticket Threads
Dear Zoho Desk Support Team, I hope you’re doing well. I wanted to bring to your attention that the current ticket export feature in Zoho Desk does not seem to include the ticket threads or conversation history. When exporting tickets, only the summaryAbility to Set Client Name During Portal Invitation
Hi Zoho Team, We would like to suggest an important enhancement to the Zoho Creator Client Portal functionality. Zoho Creator recently introduced the option to set a client’s display name in the Client Portal settings, which is very helpful for creatingスマホでキャンペンメールを見ると正しく表示されない
キャンペーンのメール（HTML）を作成しましたが、スマホ表示に切り替えると正しく表示されません（添付参照）過去に作成したキャンペーンでは特に意識してませんでしたが、問題なく表示されていたようです。うまく表示される場合とされない場合の違いは何でしょうか？136.143.188.51 blocked by spamcop
Zoho mailserver seems to be blocked by spamcop. Cant send mail to my customer. Not sure what to do.Zoho Calendar Integrated Into CRM?
I've searched around the forums but couldn't find anything addressing this . . . Is there a plan to integrate Zoho's stand alone calendar solution into Zoho CRM? The CRM calendar does an OK job but is very basic and the Zoho calendar is great, but I've only figured out to subscribe to my CRM calendar within ZCalendar - there is no 2-way sync. My preferred solution would be for ZCal to become the default calendar/event solution within Z CRM. Is this on the roadmap? ThanksCan I Create Different Page Layouts Based on a Specified Module Pick List Field
I am trying to work out how to create different page layouts based on a specified module pick list field value, like the Salesforce feature where you can define multiple record types and then create custom page layouts for each record type. This is a super important feature as for almost all the modules we are using (Leads, Potentials, Accounts) we need to be able only show fields relevant to the record type. E.g. We need a very different page layout for a consumer lead Vs a commercial lead, sameScheduling Tasks in Relation to Project End Date
I use Zoho project to help manage tasks that relate to a number of specific business events that take place. I would like to be able to have my project end date be the date of the event and then work "back" from that date to say... Add a task 2 weeks before the project end date to remind me to XYZ. Does anyone know if there is a way to base task timings back from a project due date rather than a project start date?Notes of Tasks in Zoho CRM
Hello, Is there a way to filter the Notes that appear on a Task to only show the notes related to that specific Task and not display all the Notes of the objects related to that Task (Accounts, Contacts, Deal, etc). In essence, our team struggles to understandPassing the CRM
Hi, I am hoping someone can help. I have a zoho form that has a CRM lookup field. I was hoping to send this to my publicly to clients via a text message and the form then attaches the signed form back to the custom module. This work absolutely fine whenHow to next stage blueprint in Zoho Creator
Hello, I have question, its possible to next stage blueprint? in case, Start - (first stage) Leader 1 (with condition 1) - (second stage) Leader 2 (with condition 2) - (third stage) Leader 3 (with condition 3) - (fourth stage) After first stage, i wantFeature Request: Email Follow-Up Sequences Similar to Zoho CRM
I’m wondering if Zoho Recruit is planning to introduce a feature similar to the Email Automation – Follow-Up Sequences that is available in Zoho CRM. In CRM, this allows users to send a series of timed follow-up emails triggered by specific actions (forDuplicated Notebooks
Out of the blue, almost all of my notebooks got duplicated and the different copies contain different information. Some seem like older copies than the others. I use the linux desktop app and sometimes the Android app. I assume that the sync failed at some point and was unable to merge the two versions together. But I'm afraid to add anything else to my notebook because if it can't properly sync 5 notebooks with only a handful of notes each, what will happen when I have hundreds of notes and I loseCurrency limitation when integrating Zoho CRM & Zoho Books
Brief Video of Problem: https://www.loom.com/share/d61d1d07d0904e149d80c1901a22418e. Background · Our business is based in Australia and we have to have Zoho Books in AUD to comply with tax and reporting regulations in Australia. · We sellMulti-select Lookup does not have Advanced filter options in CRM
With much fanfare Zoho announced the advanced filter options for CRM lookup fields which was a nice addition. This feature is not available for Multi-Select lookup fields. Will it be rolled out in the next 3-6 months, considering the standard lookup filterExperience effortless record management in CRM For Everyone with the all-new Grid View!
Hello Everyone, Hope you are well! As part of our ongoing series of feature announcements for Zoho CRM For Everyone, we’re excited to bring you another type of module view : Grid View. In addition to Kanban view, List view, Canvas view, Chart view andUnable to copy into a new document
Whe I create a new Writer doc and attemp to copy and past I get this message. The only way to copy into a document is I duplicate an existing document, erase the text and save it under a different name and then paste the information. Not ideal. Can youKaizen #157: Flyouts in Client Script
Hello everyone! Welcome back to another exciting edition of our Kaizen series, where we explore fresh insights and innovative ideas to help you discover more and expand your knowledge!In this post, we'll walk through how to display Flyouts in Client ScriptAdmin Control Over Profile Picture Visibility in Zoho One
Hello Zoho Team, We hope you are doing well. Currently, as per Zoho’s design, each user can manage the visibility of their profile picture from their own Zoho Accounts page: accounts.zoho.com → Personal Information → Profile Picture → Profile PicturePublished Course Not Reflecting In Hub
Hi! I am trying to create micro-learning courses for our team to be available for self-guided learning. I have published the courses with enrollment settings open to all users of the hub, but they don't appear to be available for enrollment. Am I missingUnlock Locked Users via Zoho One Mobile App
Hello Zoho One Team, We have noticed that in the Zoho One web admin panel, we can unlock a locked user when needed. However, when using the Zoho One mobile app, there is no indication that a user is locked, nor is there an unlock button similar to whatNext Page