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
Inbox Preference - Saved replies based on message repsonse with specific word
Hi There, Can one create a workflow where the Save Reply will be generic for all messages that contains a specific word, various channels,. The saved reply should contain a link for download etc. that is a response to the word entered in the message containedBasic Price List Functionality Still Missing
I am having a problem with the most simple imaginable pricing scenario - you buy cheap, add profit, then sell high. Or in less simplistic terms: business buys a product at a given cost, then adds predetermined percentage markup, and finally sells thatHow do I hire employees????
Hi! I own a bookkeeping company, where a few of my clients use Zoho Books as their accounting platform . I started utilizing Zoho Practice to work on the books of my Zoho clients, some have Zoho One and some have Zoho Books plans. I just hired an employee,Automate data upload process like reports
I'll start with the end in mind. I want to basically keep certain creator tables updated with data that are in a sql database/tables in our office (employees, active jobs, employee positions) so I can reference that data and not have to duplicate it by hand every time someone adds a new job or employee in the office desktop software. Here are some thoughts I had about how to do this, but am unsure as to whether any of them are actually possible and how to go about it from there: Is there any wayGreylisted, try again after some time
Can you check my ip, i send to duyna@vietlinkjsc.vn but have an error; my ip is 112.213.94.12 Here is log: 2018-01-09 09:40:29 H=mx.zoho.com [204.141.32.121] SMTP error from remote mail server after RCPT TO:<duyna@vietlinkjsc.vn>: 451 4.7.1 Greylisted, try again after some time 2018-01-09 09:40:32 H=mx2.zoho.com [204.141.33.55] SMTP error from remote mail server after RCPT TO:<duyna@vietlinkjsc.vn>: 451 4.7.1 Greylisted, try again after some time 2018-01-09 09:40:32 duyna@vietlinkjsc.vn R=lookuphostEmails linked to Deal
Hello everyone, I’d like to ask a question to see if someone can help me out. We are requesting availability from suppliers by sending emails directly from the Opportunity. These emails we send are logged within the Opportunity; however, when we receiveHow to transfer all my mails from Zoho to Gmail or Office 365
is there any option to move my emails from zoho to gmail or office 365. i would like to export more than 25k emails from zoho to office 365 or gmail. can anyone help me to guide properly. this will help me to access my emails easily i have both account and can easily do it with office 365 or gmail. i want two options. direct from zoho to office 365 or exported eml files from zoho to gmail. please suggest me both if possibleInquiry Regarding Image Display Issue in Campaign Duplication
We are currently using Zoho Campaigns for email distribution to our clients. I would like to inquire about an issue we encountered. When duplicating a previously created and sent campaign from the "All Campaigns" section, the images used in the headerNew integrations for Bigin: Zoho Sign, SalesIQ, and Marketing Automation
Greetings, We're excited to share new integrations that make Bigin more powerful and useful for your business! Zoho Sign for Bigin Zoho Sign now integrates seamlessly with Bigin, enabling you to sign, send, and manage contracts or agreements without leavingAdd multiple users to a task
When I´m assigning a task it is almost always related to more than one person. Practical situation: When a client request some improvement the related department opens the task with the situation and people related to it as the client itself, the salesmanWhat is Attendee Status 0 and 1?
Hi there, I recently stumbled upon the API to get the attendee list and in the return value, there is a parameter called "status", and 0 supposed to mean not_attending, and 1 means attending. I cannot find this representation anywhere in the attendeeZOHO BackStage
How to get list of events, using ZOHO BackStage APIs. Is it possible OR not?How to Customize Task Creation to Send a Custom Alert Using JavaScript in Zoho CRM?
Hello Zoho CRM Community, I’m looking to customize Zoho CRM to send a custom alert whenever a task is created. I understand that Zoho CRM supports client scripts using JavaScript, and I would like to leverage this feature to implement the alert functionality.Zoho Meeting iOS app update - Join breakout rooms, access polls, paste links and join sessions, in session host controls
Hello, everyone! In the latest iOS version(v1.7) of the Zoho Meeting app, we have brought in support for the following features: Polls in meeting session Join Breakout rooms Paste link in join meeting screen Foreign time zone in the meeting details screen.Calculate hours between 2 date/time fields
Hi, Does anyone know if it is possible to get the number of hours between 2 date/time fields in a zoho crm custom function? Thanks, MichaelExternal ID validation.
I added an external ID field as below in one of my custom modules: When creating records via the API using some value (eg: 762115b2-097e-43b2-bdba-f3924a5371a6) for this field, it works without any problem. I can create and even see the records on theCRM x WorkDrive: File storage for new CRM signups is now powered by WorkDrive
Availability Editions: All DCs: All Release plan: Released for new signups in all DCs. It will be enabled for existing users in a phased manner in the upcoming months. Help documentation: Documents in Zoho CRM Manage folders in Documents tab Manage filesRemove Address from credit card payment
I would like to remove the need to add address when paying by credit card. I only want the customer to have to add their credit card details.Create a button that executes a customized function
Hello, I have created a summary view in which I combine the data from my items table and suppliers table. I would like to know if there is the possibility of adding a button somewhere in the view to be able to execute a function when clicked on it. ICustom field doesn't fill when converting sales order to invoice
Hi, When I convert a Sales Order to an Invoice one of the custom fields on a product line names "Subsidie" does not seem to fill in automatically. I manually have to select the product again by clicking on the product name in the order line en re-selectCan I use ZOHO calendar to schedule a Youtube video that is already in my youtube account, but listed as private or unlisted?
I am creating Youtube videos and shorts and then uploading them to our Channel so others can view and approve. Once approved I would like to just schedule them over the next few days within Zoho. So far it looks like I have to re-upload the video to ZohoHow to Display a Logo Image on a Public Form?
I would like to display a logo image in the header of a form. To achieve this, I added an Add Notes field to the form. The code below works perfectly for Zoho users accessing the form. However, when the form is made public, the image does not load properly:Advice for my first project in Zoho
Hello, how can I design and implement a customized ERP and CRM system using Zoho to automate and manage core business functions, including customer relationship management, property inventory, sales tracking, and financial processes. This is one of myAssociate Email API Internal Error
I am trying to associate an already existing email within a function using the Related Emails API. To provide more context, I also have admin permissions and have ensured that the fields are correct and that I have admin permissions when associating theProfit on Sales order
Hi, would it be possible to implement a column at the Sales order overview of Purchase amount? So a field with the amount of all purchase related to this Sales order? This is very usefull so you will see the profit you made on this deal. I tried to getSubform Data in v2 REST API
What is the mechanism for adding subform data in the Creator v2 REST APIs? There is nothing documented in the Data APIs documentation (https://www.zoho.com/creator/help/api/v2/). I was able to determine how to GET the subform data by adding it to theIs the filename of an attachment restricted to only certain languages?
Hi, I tried to create a file card in a notebook, but I encountered an issue: when the filename of an attachment is in languages other than the main ones (such as English, Japanese, or Simplified Chinese......), syncing stops or the filenames become garbledHow to create comparison time periods like these examples
In a Pivot Report I would like to be able to select any date range and show a set of metrics for that date range e.g. revenue, orders, units sold. I would then like to be able to compare to the previous period based on the amount of days on the selectedOverwrite Option for custom modules
Hi Team, I noticed that the overwrite option is unavailable in Zoho Books when importing data for custom modules. This limitation makes it challenging to bulk update old data, as the only option is the 'bulk update' feature, which is restricted to 25Zoho Creator - Zoho Analytics
I am facing an issue in Zoho Analytics where I am still seeing deleted data from the Zoho Creator form I created. Could you please look into this and let me know what needs to be done?Unable to send emails
I have this email parth@mrcolumbus.in, but I couldnt send outgoing email. Can you please help?Notifications push : Encourager le réengagement et renforcer la fidélité des utilisateurs efficacement
Vous avez déjà souhaité engager et communiquer de manière proactive avec les utilisateurs, y compris lorsqu'ils utilisent votre application de manière peu active ? Zoho Apptics vous offre déjà des fonctionnalités qui vous permettent d'évaluer la performance,Easy way to delete attachments
I've reached my data limit and would like to run a view/report, and mass delete attachments. Is there an easy, fast way to do this? Moderation Update: Post Summary: There are two features the post discusses a) Easy way to remove Email attachments WillHow to add new deal to existing contact
Hi, I want to add new deal to existing contact.Domain verification is in progress... (How long do I need to wait?)
Trying to setup my first email domain by connecting with GoDaddy. Have been here for quite some time and the screen is not changing. How long should this take?Send DataSend Dataemail address autocomplete
Is there a way to eliminate certain addresses from showing up in auto complete when entering an address? Many old and unused addresses currently show up, many of which I would like to get rid of. ThanksLinking an email to a Contact when the email is sent in deluge via sendmail
The "to:" address in this code is a CRM Contact. Email address is forced unique in CRM This sendmail gets sent via a workflow which is in a custom module. It works, except that the outbound email does not appear (i.e, get linked to) the Contact such thatHow to restore deleted Field
I edited a field in zoho form and by accident I deleted a field (email address). The form is ongoing to be filled by respondent. Then, when I checked to the all entries and report, the email address is gone. I checked in audit log, there is a record thatHow to select multiple notes at once in the PC client?
In the PC client, you can select notes using ctr+LMB. But why can't you use shift+LMB? PC version 3.2.0How I can add customized Invoice
Hi, I wanna use a customized Invoice, how i can add thatNext Page