Kaizen #61 - Composite API
Hello everyone!
Have you ever wanted to make different API calls in a single request?
Save up on some API credits while still fulfilling your business case?
Reduce the round-trip time of a request?
We have got you!
What is a Composite API?
The Composite API allows you to combine up to five API requests in a single API call. You can also choose to execute all the APIs in a single database transaction, if required.
Before we look at this API in detail, let us get to know a few terms for better understanding.
- Sub-requests - the individual API requests you use in a composite request.
- Single database transaction - execution is considered complete only after all the sub-requests are executed.
- Round-trip time(RTT) - the time taken for the request to reach the server from the client and render a response in the client.
- Rollback - when one of the sub-requests fails, the previous sub-requests that were executed will be reverted, and the composite API will be rolled back.
- Concurrent execution - processing all the sub-requests at the same time, i.e, in parallel.
- Index of the sub-requests - represents the order of execution. The execution begins at the 0th index.
How does the composite API reduce the round-trip time(RTT)?
Consider that you want to fetch the module metadata of leads, insert a contact, and fetch a quote. When you combine these calls in a composite request, the RTT is much lesser than the three individual requests from and to the client.
Concurrent and parallel execution
You can execute the sub-requests sequentially or in parallel, depending on your business needs.
The Boolean keys rollback_on_fail and concurrent_execution decide the execution flow of the composite API.
- concurrent_execution - Represents whether you want to execute all the sub-requests in parallel.
- rollback_on_fail - Represents whether you want to rollback the entire composite request when one sub-request fails.
Note that these two keys cannot have the value "true" at the same time. That is, when the concurrent execution is true, a rollback cannot happen.
Let us discuss the two scenarios based on the values of these keys.
- Sub Requests are executed under the same transaction (rollback can be performed)
- Sub Requests are not executed under the same transaction
1. Sub-requests are executed under the same transaction (rollback can be performed)
- When to use?
When there are dependent sub-requests and the execution of one depends on the response of another sub-request. Here, you must reference the sub-request whose data you want to use in another sub-request.
For example, you want to upsert a record in the Contacts module(sub-request 1), upsert a record in the Accounts module(sub-request 2), and convert a lead while associating it to the previously upserted contact and account(sub-request 3). Sub-request 3 depends on the execution of sub-requests 1 and 2. This allows you to rollback the composite request when one of the sub-requests fails. That is, the contact and account will not be upserted. - concurrent_execution - false
- rollback_on_fail - true
Here is the JSON for the composite request:
{ "rollback_on_fail": true, "concurrent_execution" : false, "__composite_requests": [ { "sub_request_id":"1", "method":"POST", "uri":"/crm/v3/Contacts/upsert", "headers":{}, "body": { "data":[ { "Last_Name":"composite", "Email":"composite@test.test" } ] } }, { "sub_request_id":"2", "method":"POST", "uri":"/crm/v3/Accounts/upsert", "body":{ "data":[ { "Account_Name":"C1", "Email":"composite2@test.test" } ] } }, { "sub_request_id":"3", "method":"POST", "uri":"/crm/v3/Leads/111111000000095001/actions/convert", "body":{ "data":[ { "Accounts":"@{2:$.data[0].details.id}", "Contacts":"@{1:$.data[0].details.id}" } ] } } ] } |
2. Sub Requests are not executed under the same transaction
a. concurrent execution is false
- When to use?
When there are sub-requests that are internally dependent through an automation action.
For example, you have configured a workflow that is triggered when the vendor's name is Zylker. In sub-request 1, you update an existing vendor's name from Zoho to Zylker. In sub-request 2, you create a contact associating the recently-updated vendor using its ID. Both appear like independent requests, but have internal dependency through the workflow. That is, to trigger the workflow, you must execute sub-request 1 first, followed by the second. Hence, you cannot use concurrent execution. - concurrent_execution - false
- rollback_on_fail - false
{ "concurrent_execution" : false, "__composite_requests": [ { "sub_request_id":"1", "method":"PUT", "uri":"/crm/v3/Vendors/111111000000050313", "headers":{}, "body": { "data":[ { "Email":"v@gmail.com", "Vendor_Name":"V1" } ] } }, { "sub_request_id":"2", "method":"POST", "uri":"/crm/v3/Contacts", "body":{ "data":[ { "Vendor_Name":"111111000000050313", "Last_Name":"composite", "Email":"composite2@test.test" } ] } } ] } |
b. concurrent execution is true
Case 1: With independent sub-requests
- When to use?
When your sub-requests are independent of each other and you want to save time by executing them in parallel. For example, fetching the leads, fetching the metadata of another module etc,. - concurrent_execution - true
- rollback_on_fail - false
Case 2: With dependent and independent sub-requests
- When to use?
When you have dependent and independent requests, and you want to execute independent requests in parallel to reduce execution time. For example, you want to create a lead(sub-request 1), create a contact referencing an account(sub-request 2) which will be created in another sub-request, and create an account(sub-request 3). Here, sub-requests 1 and 3 will be executed in parallel, and sub-request 2 will be executed after receiving the response from 3. - concurrent_execution - true
- rollback_on_fail - false
Here is the sample input.
{ "concurrent_execution" : true, "__composite_requests": [ { "sub_request_id":"1", "method":"POST", "uri":"/crm/v3/Leads", "headers":{}, "body": { "data":[ { "Last_Name":"composite", "Email":"composite@test.test" } ] } }, { "sub_request_id":"2", "method":"POST", "uri":"/crm/v3/Contacts", "body":{ "data":[ { "Account_Name":"@{1:$.data[0].details.id}", "Last_Name":"composite", "Email":"composite2@test.test" } ] } }, { "sub_request_id":"3", "method":"POST", "uri":"/crm/v3/Accounts", "body":{ "data":[ { "Account_Name":"A1" } ] } } ] } |
Points to remember
- rollback_on_fail and concurrent_execution keys cannot hold the value "true" at the same time.
- You can only use a set of allowed APIs in the composite request. Refer to the Allowed APIs section on the help page.
- When rollback_on_fail is true, the automation actions are executed only when all the sub-requests are served and a rollback is not performed. If one or more sub-requests fail and a rollback happens, the automation actions are not triggered.
- Each composite API consumes one API credit, five concurrency credits, irrespective of the number of sub-requests.
How are responses and errors handled in the composite API
- A composite API renders a success response when all the sub-requests are executed irrespective of their success or failure.
- Every sub-request will have its corresponding error or success response, irrespective of the flow(concurrent or sequential).
- You can get the details of the erroneous sub-request from the index in the response.
We hope you found this post useful. Let us know your thoughts in the comments.
Cheers!
Previous Kaizen post: Get Records, Search Records, Query and Bulk Read APIs
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
Shylaja S
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
SMTP email sending problem
Hello, I've sent emails before, but you haven't responded. Please respond. My work is being disrupted. I can't send emails via SMTP. Initially, there were no problems, but now I'm constantly receiving 550 bounce errors. I can't use the service I paidunblock my zoho mail account. outlines@zoho.com
please unblock my zoho mail account, outlines@zoho.comUnable to see free plan option
Hello Zoho Support Team, I hope you are doing well. I am trying to sign up for Zoho Mail, but I am unable to see the option for the free plan. Could you please guide me on how I can access or activate the free plan? Thank you for your assistance.Outgoing blocked: Unusual activity detected.
I just made payment for my Zohomail Today and have been debited so i will like to be Unblocked because this is what it says (Outgoing blocked: Unusual activity detected) Thank you i await your swift responsesHow to remove some users in zoho accounts
How to remove some users in Zoho accounts.Forwarder
Hi, I tried to add a forwarder from which emails are sent to my main zoho account email . However, it asks me for a code that should be received at the forwarder email, which is still not activated to send to my zoho emial account. So how can I get theForwarder
Hi, I tried to add a forwarder from which emails are sent to my main zoho account email . However, it asks me for a code that should be received at the forwarder email, which is still not activated to send to my zoho emial account. So how can I get theDKIM cannot be enabled for the domain as no verified default selector present
Hi Support Team, For Domain DKIM record trying to enable status. but showing error "DKIM cannot be enabled for the domain as no verified default selector present" So, please resolve the issue. Thank you.I can't log in to my account on Thunderbird
I've just had to rebuild my PC (calamitous mess from Microsoft with Win10/Win 11 'upgrade' - they confirmed I had to start with a new build). I have used Zoho mail for years via Mozilla Thunderbird, but now I've had to download the latest version of TBird,Sorten the domain of zoho mail ids
I recently created zoho mail id and am quite excited with the features. But one issue ig nobody wanna type this big zohoaccounts.com I mean silly bold Suggestion zmail.com (sound gmail) (attraction) or some genz words looks coolWeekly Tips : Customize your Zoho Mail Notifications
In a professional context, email communication remains one of the most crucial channels for staying connected and managing workflows. Keeping track of your emails, task updates, or important announcements can be overwhelming—especially if you are jugglingHow to move emails to Shared Mailbox?
Hello, I created a Shred Mailbox instead of using a distribution group. But I cannot move previous emails to certain shared mailbox. Is it possible move some emails from inbox to shared mailbox?Email task creator when task is updated/marked complete
I am looking for a way to notify the creator of a task in zoho todo when - Task is updated Task is closed Comments entered 1 and 2 are critical, and I cannot find a zoho flow to do this. There is no way that as a manager I will know when someone has completedThe attendees will now be redirected to the landing webpage when they exit the webinar, set by the organizer.
Hello All, In the latest version of the Zoho Meeting iOS mobile app (v1.3.16), we have brought in the below enhancements: Post Webinar Re-direction Revamped exit UI for Webinar Post Webinar Re-direction: The attendees will now be redirected to theDownload API file contents from browser
Hi Team - is there something being planned to be able to trigger file downloads from the browser via a deluge script? i.e. retrieve a file via API, trigger the file download directly from the browser. Or... using the convertToPdf function (https://www.zoho.com/deluge/help/functions/file/convert-to-pdf.html)March 15, 2023: Zoho Docs is discontinued
As of today (March 15, 2023) Zoho Docs is discontinued for all users. We would like to thank our customers for trusting us for so many years! Going forward, we're confident you'll enjoy using Zoho WorkDrive for all your advanced file management and collaborationWhen using "locations" in zoho books, can you keep the two locations totally separate from each other?
I am looking to add a location but I don't want to intermingle the banking or other accounts. I want that to be like two separate independent branches that use different banking accounts, accounts payable, and accounts receivable. The people who are inAdding a Channel to SalesIQ
I have a client that currently uses Zoho CRM and Zoho Desk. They would like a live chat to place on their website that has a mobile app and chat bots (something like SalesIQ). However, they would also like to have all this work over SMS as well. Does the SalesIQ API allow this? Can I add visitors without them being a visitor on a website? Thanks! Bryan RedeagleDataPrep Bigquery Connection failed
Hello everybody, I want to create a connnection beetwen Bigquery and Dataprep but when I try to connect my project I got this error Loading tables has failed. Table list fetched from the data source expired.How Do I Refund a Customer Directly to Their Credit Card?
Hi, I use books to auto-charge my customers credit card. But when I create a credit note there doesn't seem to be a way to directly refund the amount back to their credit card. Is the only way to refund a credit note by doing it "offline" - or manually-Zoho Flow Needs to Embrace AI Agent Protocols to Stay Competitive
Zoho Flow has long been a reliable platform for automating workflows and integrating various applications. However, in the rapidly evolving landscape of AI-driven automation, it risks falling behind competitors like n8n, which are pioneering advancementsImportant Features Missing
Hey all I love linkthread, but i am missing some important features. I want to be able to include my Google Tag Manager. I have all the important stuff in my GTM Container: Facebook Pixel, LinkIn Pixel, Zoho Pagesense and so on. So i am able to do retargetingZoho SignForms: Prefill parameters with spaces render as “+” in the document (even when using %20)
Hello Zoho Sign team, we are using SignForms with prefill parameters passed via URL. Spaces in parameter values are being rendered as “+” in the finalized document—even when we URL-encode spaces as %20. This is critical for us because we prefill addressesCurrency selector (based on variable) usage in comparsion
Hi, I've developed a currency selector based on the following topic, and it's working well in pivot tables and charts: https://help.zoho.com/portal/en/community/topic/how-can-i-allow-my-users-to-choose-a-currency-for-the-dashboard I also have a comparisonCustomize Column in Projects - Default View for Template?
Is there a way to have the columns you'd like to see added to a template? I want my customized columns to show up every single time I create a project from that template. It appears I can customize them in the template but when I create the project they do not transfer over. Template: See below how the columns in order are : Task, Owner, Status, Assigned, Website URL, Blog H1..etc. When I create a project from that same template it comes out as: Task, Owner, Status, Tags, Start Date, End Date, etcAsk the Experts 24: Analytics, data administration, and mobile experience with Zoho Desk
Hello Everyone! Welcome back to the Ask the Experts(ATE) series! We were so focused on our Autumn 2025 release that we didn't host an ATE session last month. In this month's ATE, we'd like to expand our areas for discussion: we'd like to listen to yourMulti-Page Forms in Zoho Creator!
Let’s make long applications easier to handle by dividing them into pages, adding a progress bar, and guiding users step by step through complex data entry. This would be a total game-changer for the user experience and could significantly boost completionEmail login error
Login successfully but email page errorShared Mailboxes Disappeared
Zoho Mail users in our company haven't been able to see their Shared Mailboxes for the past few hours. I've checked with App and Web Access, but they can't access them. When I send emails to their addresses, I get no error messages. They're still visibleRemote Server is misconfigured
Dear Team, I am unable to use email id as remote server is misconfigured. It would be really great if you could help on this and get this resolved. Thanks & Regard Rohit Guptawhy cant i access my email account. it keeps asking me for reverifiying my account by entering my password.
I cant access my account. it keeps asking me for reverifcaton by entering my password. once its entered it asks for it over and over.Free webinar alert on October 16 - Less Complexity, More Security: Workplace + Directory
Hello Zoho Workplace Community! Security and productivity shouldn't be at odds—and with Zoho, they're not. Discover how Zoho Workplace + Directory delivers seamless collaboration with enterprise-grade security, all in one integrated ecosystem. Join ourEmail Recall Feature In Zoho Mail Which Should Also Work For Outside Organisation Members
Add a feature to recall or undo sending an email within a configurable short time window (e.g., 30 seconds to 2 minutes) after hitting send, similar to Gmail’s undo send. Currently the sent email can not be recall If the recipient is not from within yourWorkdrive and ChatGPT Team Synced Connectors
Hi, we want to be able to integrate Zoho Workdrive with OpenAI’s ChatGPT Team plan. Google Drive and OneDrive both offer this, zoho please catch up asap. We dont want to have to put our company files in google drive, we want to allow chatgpt Team editionAlias Name (on items) use case in Zoho inventory
Hey, Hope everyone is well. Wondering if anyone can shed some light on the use case of Alias Names on Products in Zoho Inventory? Cheers, ChrisUpdating an Invoice Line Item's Discount Account via API Call / Deluge Custom Function
I need help updating an invoice line item's discount account via API. Below is a screenshot of the line item field I am referring to. Now the field to the left of the highlighted field (discount account) is the sales income account. I am able to modifySend e-mail with attachments
Dear Zoho, How is that possible in Zoho Flow to send an e-mail with attachment? Just a simple example: Zoho Flow checks my Zoho mails and if the conditions starts the trigger then I would like to send an email with the original email's attachment. Any idea? BR, AdamHow to I get checkboxes on a subform to update via deluge
Hello, would someone be able to tell me what I'm doing wrong here? I am trying to take the contents of a Deals subform and add them to an invoice then update the checkbox on each row so that 'add to invoice' is unticked and 'invoiced' is ticked. The outputYour bot just got smarter: AI-Powered routing that reads between the lines
What if your bot could tell the difference? Between a visitor who just needs a quick answer, someone actively comparing options, and a frustrated customer one click away from leaving? Most bots can't. They deliver the same response to everyone, missingUrgent Security Feature Request – Add MFA to Zoho Projects Client Portal Hello Zoho Projects Team,
Hello Zoho Projects Team, We hope you are doing well. We would like to submit an urgent security enhancement request regarding the Zoho Projects Client Portal. At this time, as far as we are aware, there is no Multi-Factor Authentication (MFA) availableNext Page