Kaizen #33 - Triggering Workflow Rules, Approvals, and Blueprints via Zoho CRM API

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:
  1. 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.
     
  2. 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":[]
  3. 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:
-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







                            Zoho Developer Community





                                                  Use cases

                                                  Make the most of Zoho Desk with the use cases.

                                                   
                                                    

                                                  eBooks

                                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho Desk.

                                                   
                                                    

                                                  Videos

                                                  Watch comprehensive videos on features and other important topics that will help you master Zoho Desk.

                                                   
                                                    

                                                  Webinar

                                                  Sign up for our webinars and learn the Zoho Desk basics, from customization to automation and more

                                                   
                                                    
                                                  • Desk Community Learning Series


                                                  • Meetups


                                                  • Ask the Experts


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner




                                                            • Sticky Posts

                                                            • Kaizen #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.
                                                            • Celebrating 200 posts of Kaizen! Share your ideas for the milestone post

                                                              Hello Developers, We launched the Kaizen series in 2019 to share helpful content to support your Zoho CRM development journey. Staying true to its spirit—Kaizen Series: Continuous Improvement for Developer Experience—we've shared everything from FAQs
                                                            • Kaizen #193: Creating different fields in Zoho CRM through API

                                                              🎊 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.
                                                            • Client Script | Update - Introducing Commands in Client Script!

                                                              Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! Commands


                                                            Manage your brands on social media



                                                                  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

                                                                                      • CRM Community Learning Series

                                                                                        CRM Community Learning Series


                                                                                      • Kaizen

                                                                                        Kaizen

                                                                                      • Functions

                                                                                        Functions

                                                                                      • Meetups

                                                                                        Meetups

                                                                                      • Kbase

                                                                                        Kbase

                                                                                      • Resources

                                                                                        Resources

                                                                                      • Digest

                                                                                        Digest

                                                                                      • CRM Marketplace

                                                                                        CRM Marketplace

                                                                                      • MVP Corner

                                                                                        MVP Corner







                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now


                                                                                            Zoho Show Resources


                                                                                              Zoho Writer Writer

                                                                                              Get Started. Write Away!

                                                                                              Writer is a powerful online word processor, designed for collaborative work.

                                                                                                Zoho CRM コンテンツ








                                                                                                  Nederlandse Hulpbronnen


                                                                                                      ご検討中の方




                                                                                                            • Recent Topics

                                                                                                            • Zoho Analytics & Zoho Desk - but not all desks

                                                                                                              I have several desks in our company and one of those is used by our HR department. I want to bring through the data to the shared Zoho Analytics workspace - except for the HR desk. Can this be excluded at data import stage ?
                                                                                                            • Incoming Emails Not Showing Up in Zoho Inbox

                                                                                                              Hi - I have my Zoho email account set up to forward a copy of all incoming emails to a secondary Gmail address, whilst retaining the original email in the Zoho inbox. However, all my incoming emails are currently not showing up in my Zoho inbox, so I'm
                                                                                                            • How to retrieve my following requests on this forum?

                                                                                                              Sorry, but I did not find the proper subforum for this question.
                                                                                                            • How to list emails in a folder, e.g. Inbox, on multiple pages when using Zoho mail webpage?

                                                                                                              Something as shown in the figure. There are totally 50 emails in Sent folder. If "Mail per page" equals 20, then the Sent folder is split into 3 pages. When I wander through Sent folder, I can just select a specific page to jump to. BTW, it seems that
                                                                                                            • Unable to Create Zoho Booking via the Book Appointment API

                                                                                                              Its giving the below error {     "response": {         "errormessage": "Error setting value for the variable:customer_details\n null",         "status": "Error"     } } Request: POST Url: https://www.zohoapis.in/bookings/v1/json/appointment attached Zoho-oauthtoken
                                                                                                            • SHEET - Send email when a cell changes

                                                                                                              I would like to create a custom function for Zoho Sheet that triggers when a paticular cell changes to a specific value. This would result in sending an email to a recipient (this would be an address that remains the same and included in the script). Example: = IF(N4= "Drafted", <>EmailFunction) 1)     Cell N4 changes to "Drafted" 2)    Email is sent to recipient            or alternatively 3)    Post to chat channel I have found the Custom function editor in Sheet. I am not bad at scripting, but
                                                                                                            • 【開催報告】 福岡 ユーザー交流会 2025/8/8(金)

                                                                                                              皆さま、こんにちは。コミュニティチームの中野です。 8/8(金)に、福岡 ユーザー交流会を開催しました。 本投稿では、その様子をお届けします。当日の登壇資料などもこちらに共有しますので、参加できなかった皆さまもご参照ください。 今年初の開催となる福岡 ユーザー交流会では、CreativeStudio樂合同会社 前田さんによるZoho CRM / Sign / Survey の事例セッションのほか、 Zoho社員セッションでは、Zoho Forms の活用法を解説。 さらに、「見込み客・顧客データの管理/活用方法」をテーマに参加者同士でZoho
                                                                                                            • no me llegan los correos a Zoho mail

                                                                                                              No puedo recibir correos pero sí enviarlos, ya hice la modificación de MX y la verificación de teléfonos, qué es lo que ocurre? gracias
                                                                                                            • Error: Invalid login: 535 Authentication Failed

                                                                                                              I have used zoho with nodemailer. const transporter = nodemailer.createTransport({ host: 'smtp.zoho.com', port: 465, secure: true, auth: { user: 'example@example.com', pass: 'password' } }); While sending the mail, it shows the following error: Error:
                                                                                                            • Zoho Renewal

                                                                                                              Hello, If I am not going for zoho email renewal. will i get back my free zoho account? and if yes then is it possible to get back my all free user. how many user get back 10 or 25?
                                                                                                            • javax.mail.authenticationfailedexception 535 authentication failed

                                                                                                              Hi, I am facing 535 authentication failed error when trying to send email from zoho desktop as well as in webmail. Can you suggest to fix this issue,. Regards, Rekha
                                                                                                            • Not reciving emails

                                                                                                              Apparently i cannot recive emails on my adress contact@sportperformance.ro I can send, but do not recive. The mail i'm trying to send from mybother adress gets sent and doesn't bounce back... but still doesn't get in my inbox. Please advise
                                                                                                            • Not receiving MailChimp verification e-mail

                                                                                                              It seems that their verification e-mails are blocked. I can receive their other e-mails, but not their verification of domain ownership e-mail. I've checked and double checked how I typed the e-mail, using different e-mails (my personal e-mail can receive it), white listing the domain and all that is left is for the IP's to be white listed, but I don't have that power.  If a staff member could take a look at this -> http://mailchimp.com/about/ips/ And perhaps white list them for me, that would be
                                                                                                            • Creating my 2nd email account

                                                                                                              After creating my first email address, I decided to get another email address. I would like to use this new address as the primary address too. I don't know how to set it up there doesn't seem to be an option for that
                                                                                                            • Cannot - create more email account - Unusual activity detected from this IP. Please try again after some time

                                                                                                              Hello, I come across the error message in Control Panel. Unusual activity detected from this IP. Please try again after some time and i cannot create any more users We are an IT company and we provide service for another company Please unlock us.
                                                                                                            • "Unable to send message;Reason:553 Relaying disallowed. Invalid Domain"

                                                                                                              Good day. When I try to send mail through ZOHO mail I get the following error : "Unable to send message;Reason:553 Relaying disallowed. Invalid Domain" I need help with this. My zohomail is : @eclipseweb.site Thank you,
                                                                                                            • Transfert de domaine pour création des comptes emails

                                                                                                              Bonjour , je ne parviens point à créer des mails avec le domaine 'raeses.org' suite à la souscription du domaine auprès d'un autre hébergeur, dont j'ai fait la demande du code de transfert qui est le suivant : J2[U8-l0]p8[ En somme, attente de l'activation
                                                                                                            • Help! Unable to send message;Reason:554 5.1.8 Email Outgoing Blocked.

                                                                                                              Kindly help me resolved this issue that i am facing here.
                                                                                                            • How are people handling estimates with Zoho inventory?

                                                                                                              We are often using Zoho Books for estimates that then get converted to invoices within Books. We would like the sales team to migrate entirely to Zoho Inventory and no longer need to use Zoho Books so that they are only on one system. How are people managing
                                                                                                            • Relative Date Searches

                                                                                                              Currently in the search options, it has "date", "from date" and "to date". I think it would be great if there were options like "date greater than x days ago" and "date less than x days ago". I realise that as a once off you can just use the existing
                                                                                                            • Performance is degrading

                                                                                                              We have used Mail and Cliq for about three years now. I used to use both on the browser. Both have, over the past 6 months, had a severe degradation in performance. I switched to desktop email, which appeared to improve things somewhat, although initial
                                                                                                            • Ask the Experts 23: Customize, utilize, and personalize with Zoho Desk

                                                                                                              Hello everyone! It's time for the next round of Ask the Experts (ATE). This month is all about giving Zoho Desk a complete makeover and making it truly yours. Rebrand Zoho Desk with your organization’s details, customize ticket settings based on your
                                                                                                            • Dear Zoho CEO: Business Growth is about how you prioritise!

                                                                                                              All of us in business know that when you get your priorities right, your business grows. Zoho CRM and Zoho Books are excellent products, but sadly, Zoho Inventory continues to lag behind. Just this morning, I received yet another one-sided email about
                                                                                                            • Payroll In Canada

                                                                                                              Hi, When can we expect to have payroll in Canada with books 
                                                                                                            • Please review and re-enable outgoing emails for my domain

                                                                                                              Hello Zoho Support, I have recently purchased a new domain and set up email hosting with Zoho. However, my account shows "Outgoing Email Blocked". I am a genuine user and not sending bulk/spam emails. Please review and re-enable outgoing emails for my
                                                                                                            • Payroll without tax integrations (i.e. payroll for international)

                                                                                                              It seems as though Zoho waits to develop integrations with local tax authorities before offering Zoho Payroll to Zoho customers in a country. Please reconsider this approach. We are happy Zoho Books customers, but unhappy that we have to run payroll in
                                                                                                            • goingout e mail block

                                                                                                              info@ozanrade.com.tr
                                                                                                            • Incoming mails blocked

                                                                                                              Zoho User ID : 60005368884 My mail Id is marketing#axisformingtechnology.com .I am getting following message "Your Incoming has been blocked and the emails will not be fetched in your Zoho account and POP Accounts. Click here to get unblocked." Please
                                                                                                            • Assistance Needed: Ticket Status Not Updating and Sorting by Last Customer Reply in Zoho Desk

                                                                                                              Hello, I’m facing two issues in Zoho Desk that I’d like your guidance on: Ticket Status Not Updating: When a customer replies to a ticket, the status does not change to Reopened. Instead, it remains in Waiting on Customer, even after the customer’s response
                                                                                                            • Configuring Email Notifications with Tautulli for Plex

                                                                                                              Hi I'm new to Zoho. I am from Canada and I have a I use a web based application called Tautulli for Plex that monitors my Plex media server. It also sends a newsletter to my followers. To set this up they require a "From" email address., a smtp server
                                                                                                            • Is there a way to automatically add Secondary Contacts (CCs) when creating a new ticket for specific customers?

                                                                                                              Some of our customers want multiple contacts to receive all notifications from our support team. Is there a way to automatically add secondary contacts to a ticket when our support team opens a new ticket and associates it with an account? This would
                                                                                                            • How to Set Up Zoho Mail Without Cloudflare on My Website

                                                                                                              I'm having some trouble with Cloudflare here in Pakistan. I want to configure Zoho Mail for my domain, but I'm not sure how to set it up without going through Cloudflare. My website, https://getcrunchyrollapk.com/ , is currently using CF, but I'd like
                                                                                                            • Spam is Being Forwarded

                                                                                                              I am filtering a certain sender directly to the Trash folder. Those messages are still being forwarded. Is this supposed to happen?
                                                                                                            • IMAP Block

                                                                                                              My two accounts have been blocked and I am not able to unblocked them myself. Please respond to email, I am traveling and this is urgent.
                                                                                                            • "DKIM not configured"

                                                                                                              Hello. I have been attempting get the DKIM verified but Toolkit keeps sending the message that it is not configured, but both Namecheap and Zoho show it as configured properly. What am I missing?
                                                                                                            • Zoho mail with custom domain not receiving email

                                                                                                              i registered zoho mail with my own domain. I can login and access the mail app. I tried to send email from an outlook email account and an icloud email account. Both emails were not received. My plan is free. I also tried to send email from this zoho
                                                                                                            • Set connection link name from variable in invokeurl

                                                                                                              Hi, guys. How to set in parameter "connection" a variable, instead of a string. connectionLinkName = manager.get('connectionLinkName').toString(); response = invokeurl [ url :"https://www.googleapis.com/calendar/v3/freeBusy" type :POST parameters:requestParams.toString()
                                                                                                            • Waterfall Chart

                                                                                                              Hello, I would like to create a waterfall chart on Zoho analytics which shows the movement in changes of budget throughout a few months, on a weekly basis. Should look something like the picture below. Does anyone know how to?
                                                                                                            • Help Center and SEO: Any Benefit to My Domain-Mapped Website Ranking?

                                                                                                              First of, I love the Help Center which I've just decided to integrate into my website to replace its old-fashioned FAQs. So much more to achieve there now! Lots of new benefits to the site visitors and to me in terms of organizing and delivering all the
                                                                                                            • Issue with Importing Notes against Leads

                                                                                                              Hi, I am attempting to import some Notes into Zoho CRM which need to be assigned to various Leads. I have created a csv file which I am testing that contains just one record. This csv file contains the following columns: Note Id Parent Id       (I have
                                                                                                            • Next Page