Kaizen 158 - How to effectively handle API calls to optimize API credits?
Hello everyone!
Welcome back to another post in the Kaizen series!
In this post, we will discuss a few strategies to handle API calls effectively and optimize your API credits.
As you all know, your CRM edition comes with a set number of credits(this varies based on the number of licenses purchased) and all API calls consume these API credits. Refer to our API limits page for more information on the credit system.
Businesses use different processes for different needs, so they use different APIs. Here are a few strategies that can help you optimize your API usage and save up on credits while still maintaining efficient operations.
- Understand API Credit Consumption
- Optimize API Calls - Batch and bulk
- Implement Caching Mechanisms
- Minimize Redundant Calls
- Analyze Usage - track credit usage, set alerts
- Increase Credits to fit your needs
1. Understand API Credit Consumption
The primary step to optimize your usage is to understand it and know the credit system. Each API call consumes a specific number of credits based on its type. For example, a standard Get Users API call costs 1 credit, while a more complex operation, like converting a lead, consumes 5 credits.
Refer to the credit consumption table provided on the API Limits page to plan your usage efficiently.
2. Optimize API Calls
Batch Requests
Whenever possible, batch requests to combine multiple operations into a single API call. For instance, consider that you want to insert or update 20 records. Insert/Update Records API consumes 1 credit for every 10 records. So, instead of making the API call 20 times and spending 20 credits, you can insert or update all 20 records in a single API and spend only 2 credits.
You can also use Composite API to combine up to 5 API calls as sub-requests in one composite request based on your use case.
Bulk APIs
For large data sets involving thousands of records, leverage bulk APIs that can process multiple records in a single request. This approach not only saves credits but also enhances performance by reducing the number of individual requests sent to the server.
Furthermore, these APIs support callback by which you can reduce polling(thereby saving credits) and get near real-time notification of the bulk job.
Refer to our Kaizen post on When to use Get Records, Search Records, COQL and Bulk Read APIs? to decide which API will suit best for a given scenario.
3. Implement Caching Mechanisms
Store frequently accessed metadata locally or in a temporary cache. This allows you to get the data from the cache instead of making multiple calls to get the same information. Caching metadata of modules and fields would be a game changer as these are one of the most frequently accessed data.
4. Minimize Redundant Calls
Upsert Records API instead of Insert/Update Records
Use the upsert records API while creating records. If you have enabled duplicate check based on unique fields or display label, this API checks if there are existing records, and updates or inserts, accordingly. This helps you save up on credits instead of searching for records and then inserting or updating them.
Use Webhooks
Use webhooks to receive notifications about changes in data instead of polling. This reduces the need for frequent API calls to check for updates.
For example, when you use bulk APIs, they support both polling and callback. Use callback to get notified about the status of the job instead of using the API to poll for an update.
Similarly, you can use the Notification API to receive near real-time notification about changes in data. For instance, when you want to know whenever a deal is created, subscribe for the create action on the Deals module using the Notification API. This helps you avoid making repeated Get Records API calls to check for new records.
Instead of polling for updates, utilize webhooks to receive near real-time notifications about changes in data. This reduces the need for frequent API calls to check for updates. Notification APIs allow you to get near real-time notifications on data in CRM, while the Bulk APIs support both polling and callback op.
5. Monitor and Analyze Usage
Track API Credit Usage
Regularly monitor your API credit consumption through the API dashboard. The Dashboard gives you a comprehensive view of your credits, the usage pattern, consumption by modules, functions, integration tasks, etc. Understanding these patterns can help identify areas where you can avoid spending credits and optimize further.
Set Alerts for High Usage
Zoho CRM alerts the super admin of the org via an email whenever the API usage reaches 80, 90, or 100% of the available credits. Configure alerts based on your critical threshold limits to avoid unexpected disruptions. Refer to this page to learn how you can customize these alerts.
6. Increase Credits Wisely
Estimate Requirement Accurately
If you find that your organization consistently exceeds its credit limits, consider increasing your API credits from the API dashboard conveniently. Be mindful about add-on credits based on usage data in the past. Zoho CRM uses the pay-as-you-go model for add-on credits, so you only pay for what you use.
We hope that these simple strategies will help you optimize your API calls in Zoho CRM, effectively manage your API credits, and reduce unnecessary costs while maintaining efficient operations.
Let us know your thoughts in the comment section. Write to us at support@zohocrm.com if you have any questions.
See you next week!
Cheers!
Access your files securely from anywhere
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
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! CommandsKaizen #165 : How to call Zoho CRM APIs using Client Script
Welcome back to another exciting Client Script post! In this post, we will discuss one of the most frequently asked questions: How do you call Zoho CRM APIs from Client Scripts? In this kaizen post, 1. Ways to make calls to Zoho CRM APIs using ClientKaizen#162 : Add Tags and Open Pre-filled Email Drafts via Client Scripts
Hello everyone! Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script. 1. How to auto-tag a record based on field update? 2. How to Open a pre-filled email draft This post will provideExtension Pointers - JS SDK series #4: Managing data from a widget using ZOHO.CRM.HTTP
Handling and managing the data between two applications is a major factor for an efficient business. There are a variety of ways to handle data between Zoho CRM and other third-party applications. You can use deluge CRM tasks, create connectors, use APIKaizen #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 achieved
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho DataPrep Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho Campaigns 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
Change format of quantity format
Hi, I would like to change the qunatity format from 1,00 to 1. Is this possible? thanks!Ticket Views: filter criteria -> dynamic date values in relation to the current date
Hello all, It would be very helpful if you could build custom views in such a way that you do not have to adjust the criteria daily or at whatever interval in order to change the fixed date value as needed. For example, I would like to create a view that,Captchas: No support for Google reCAPTCHA or similar
Hi all, The current captcha integrated into Creator is very basic, and often near-impossible to read. I'm building an app for a charity which includes a couple of public-facing forms, and this is a real issue for people with dyslexia and related conditions - it's effectively excluding them if you want any form of spam protection at all on your published forms (and that being said, the current captcha doesn't even seem very effective - bots can often read it more easily than humans). I've raised thisMaintain consistency in ticket responses with shared snippets
Hello everyone! We are excited to announce that our highly anticipated snippet sharing feature is now available to all users. As you know, snippets are pre-defined message templates, or canned messages, that help agents respond to tickets with efficiency.Tickets - Zoho Desk
Hi Team, My Clients need to see their tickets created and the status of the ticket in the Zoho Support Desk itself. How can I do this? My Client doesn't have a Zoho Account. They need to access the ticket by the provided link without signing in.Automatically assign Contacts to Account owners
Hi, I have a finite number of accounts set up in the CRM, and each new contact that comes in is automatically assigned to an Account according to a rule I set up. I want the Contact owner in the Contacts module to be assigned to the relevant Account owner.Making Copies/Duplicates of Zoho Forms (Shared)
Question to the community: is there a way to take a 'shared form' , make a duplicate copy and save under My Forms, so that i can use that which was already created as a template to make updates to and use as a test form and be able to have full access,Using IMAP configuration for shared email inboxes
Our customer service team utilizes shared email boxes to allow multiple people to view and handle incoming customer requests. For example, the customer sends an email to info@xxxx.com and multiple people can view it and handle the request. How can I configureCan you help us creating a customised form with payment link?
I would like to create a customised Transport form where the user will be asked to make payment basis the drop/ pick up they select.Deleting or disabeling predefined ticket list views
Is it possible to delete or disable predefined views or is this still not possible? For instance, we are not using the chat function and therefore have no use for the "Missed Chats" view. Thanks!Email an Invoice from API
When calling the API to email an invoice, it seems it does not actually send it. Below is a screen shot where I used an API call for the bottom record, and it updated its' status to "Due Today", but no email was actually sent. The top record, I hit theUnable to load your extension. Please check your plugin-manifest or Resources.json.
Hi Team, I am using the config module with multiple fields of different types, such as checkboxes and picklists. However, I am encountering the following issues: Error Message: When loading the extension, I get the error: "Unable to load your extension.Layout Rules / Quick create
Hello, is there a way to create a layout rule for quick create option? Regards, KatarzynaIssue with Create Note Button and Popup Form in Leads Module
Hello Zoho Community, I am trying to implement a "Create Note" button in the Leads module with the following functionality: 1. When the button is clicked, a form should pop up with fields to add notes. 2. After filling out the form and clicking Send,Finding draft ticket replies
Is there a way to see all tickets which have draft replies?Guidance on Making Zoho Desk Connections Available for All Data Centers
Hi Team, I’m currently developing an application using Zoho Desk connections to manage OAuth for my third-party products. Could you please advise on the steps required to make it available across all data centers? Looking forward to your thoughts onAble to change project on timelog entries
Ability to move the timesheet entry from one project to another. When a user adds a wrong entry a manager can change/update the timesheet entry to the correct project.Caso de Uso | Menos trámites, más salud: Clínicum optimiza sus recursos con Zoho One
"La automatización del proceso de solicitud de bajas y su trazabilidad a través de Zoho nos ha supuesto una mejora en el ROI." - Carol Rodríguez, Responsable de Experiencia del Cliente interno y externo en Clínicum ¡Hola a todos! Estamos emocionados deHow do I stop getting notified about upgrading to Upgrade now and save big!
How do I stop getting notified about upgrading to Upgrade now and save big! There is no way to clear this notification, and EVERY Day I get alerted to upgrade, but there is no permanent way to dismiss this alert! How can I permanently dismiss this aDouble opt-in notifications and customizable confirmation messages for your webforms
Dear CRM Community, We are excited to announce a major upgrade to our Webforms feature. You can now customize the confirmation message shown to your users who double opt-in from your webform and also customize your confirmation emails when they submitBulk create tasks - Zoho Projects API
Hi Zoho/Community, I am trying to create multiple tasks in a single API call, is there a way we can combine multiple request bodies into one single payload? The issue I am facing is the rate limiting on the API, I wanted to create certain amount of tasksTask Due dates and Reminder Date & Time
I like to have a reminder on many tasks in Zoho Recruit. I find the process cumbersome in that each task requires the following: 1. click and select due date 2. Click the reminder box 3. Click on (Reminder) Start Date 4. Click on (Reminder )Time If oneUnable to Access Admin Console and Email Sending Issues
Hello Zoho Support Team and Community, I hope this post finds you well. I am currently facing two significant issues with Zoho services: Admin Console Access Issue: Every time I try to access the Zoho Admin Console, it gets stuck on the loading screenTracking new lead response time
Hi, I have a team of Sales Development Reps, who have a KPI of responding to a lead within 20 mins or less once it hits the system. I seem to recall that Zoho CRM had the capability to track this in a previous version, but don't see it anywhere. It'sGetting The Following Error.. 550 5.4.6 Unusual sending activity detected
I just launched a marketing campaign and I got this error. Everything was working fine previously. This is a big launch so need to fix it asap. Can anyone help?Printing on 80mm bluetooth Pos Printer
Hello. I am trying to print receipts and invoices using my 80mm bluetooth connectivity Pos printer. I have configured the Templates to Retail so that it matches the paper width of the Pos printer. However, when I click Print in zoho, first it opens theTrying to integrate gmail but google keeps blocking Zoho access for integration??
hi i am trying to integrate a gmail account so can track/access business emails this way. I have followed the instructions but after selecting my email account it gets re-routed to this message (screengrab below) Can anyone advise a way around this orWhich attribute in Zoho books invoice api represent branch attached to the invoice?
Hi Zoho Team, We have done the integration with Zoho Books API. While fetching data from Invoice API we want to get branch value attached to the invoice. We could not figure out which field in "Get an Invoice" api represents branch value attribute. ThanksHow to Billed from two different GST Numbers
How to Billed from two different GST Numbers. Suppose ABC & Co had GST registration in Delhi and Haryana and Zoho account is created with Delhi GST Registration number. Now i also want to issue invoice from Haryana GST Registration number. How can i proceed ?How to hide Predefined views
Hi, I would like to know how to hide: Predefined views and Recent views or some records from this list. If I'm using it form iPad I have to scroll to see User created views. Or maybe it's possibility to move User created views on the top. All the best,Deleting Views
How do you delete views? Please sydFixed Assets
Where would I manage my fixed assetsReport on Assets
Hi, Is it possible to report purchased assets on a specific year? The Balance Sheet shows everything up to the current date, and the expense reports will not show purchased assets because they are assets not expenses. If it is not possible, then is it possible to setup an API connection with Books to extract data from to another Reporting application?Purchase of Fixed Assets
How can I record the purchase of assets using zoho books? For example, I purchased 4 laptop for 100000 $ each and paid it through my bank account. How can I record this transaction and maintain track of how much of the assets I bought?Where is the Fixed Asset Register?
I am a Zoho One user for 18 months, using invoicing and CRM and now ready to migrate my books to Zoho Books. Where do I keep the fixed asset register for the equipment that I use in my business? I have a service based business with a lot of gear and businessKaizen #168 - Incremental Authorization
Welcome to this week's post in the Kaizen series. In this post, we will discuss Incremental Authorization. What is Incremental Authorization? Incremental Authorization is an OAuth strategy that allows a client to request specific authorization scopesConfigure Notes Title for Blueprint Transition
It'd be very helpful to be able to configure note titles on blueprint transitions when requiring notes. This would help tie back the history of notes to the blueprint actions. We have some approval processes in our blueprint and require notes for theAn update to improve email delivery | Email Authentication & Relay
Dear Zoho Recruit Community, We hope this message finds you well. This post is to inform you about an important update regarding the authentication of all email domains in your Zoho Recruit account. Effective 31st December, 2024, emails sent using emailStop adding Default ID column to xls exports
When anything is exported to xls, Zoho adds a column with an ID. WE DO NOT WANT THIS COLUMN. We use an automated report to a team. We have our own tracking number. 1. This makes the report messy, it just pushes OUR data off to the right. 2. We haveZoho cases and remote work api
How to use zoho cases listing api? When i try to hit the endpoint specified in the docs , i get the error : the page you are looking for does not exist with a 401.Next Page