Extension Pointers - JS SDK Series #8: Use the SearchRecord API in a widget to simplify business operations
Looking up relevant business information is easier when you have an internal search feature that targets certain keywords or phrases. Often times, this information will be worked with and manipulated to be useful for the current task the searcher is doing, which means that a faster internal search process will lead to better productivity.
The SearchRecord API is used to retrieve records that match your search criteria. It performs a module-level search based on either a phone number, email address, word, or other piece of criteria. It's most helpful to search for text in the fields of data type "string", "phone", or "Email".
In this post, we will look at an example that involves searching for and updating records using the searchRecord and updateRecord APIs. We'll first give the syntax followed by an example scenario.
SearchRecord API
Syntax
ZOHO.CRM.API.searchRecord(config, page, per_page) |
Here, config refers to the configuration object of the 'object' type, page refers to the page number, and per_page refers to the number of records to be generated per page.
Configuration Object
Name | Type | Description |
Entity | String | SysRefName (of the module) |
Type | String | Allowed values "email|phone|word|criteria" |
Query | String | Query string |
delay | Boolean | Query string |
UpdateRecord API
Syntax
ZOHO.CRM.API.updateRecord(config) |
Here, config refers to the configuration object of the 'object' type.
Configuration Object
Name | Type | Description |
Entity | String | SysRefName (of the module) |
Trigger | list | The trigger input can be "workflow", "approval", or "blueprint". If the trigger is not mentioned, the workflows, approvals, and blueprints related to the API will get executed. Enter the trigger value as [] to not execute the workflows. |
API data | String | The data to be updated is constructed as updateRecord's API Data parameter. |
Let's take a simple scenario where a Zoho CRM user is handling a customer case. They would like to check if a similar problem has already been addressed in another case and if they can use any of those solutions for their own case. In our example, we will see:
- How the SearchRecord API can help the user find solutions using keywords related to the current case
- How the Search API returns the description and the solution of cases based on the keywords we enter
- How the user can update the correct solution to the current case if the relevant solution is found
SearchAPI.js code snippet
Util={}; var EntityIds; var EntityName; var inputtext; var solutiontext; var solutiondescription; //Subscribe to the EmbeddedApp onPageLoad event before initializing the widget ZOHO.embeddedApp.on("PageLoad",function(data) { EntityIds=data.EntityId; EntityName=data.Entity; //Search for solutions using input search words Util.search=function() { inputtext=document.getElementById("inputword").value; //Searches across the cases module for the input text entered ZOHO.CRM.API.searchRecord({Entity:"Cases",Type:"word",Query:inputtext}) .then(function(data){ console.log(data); rec=data.data; $('#solutionlist').empty(); //Looping through the solutions for (i = 0; i < rec.length; i++) { /*populating the solution list list with the solutions and description of all the cases associated with the input text provided*/ solutionsid=rec[i].id; solutionname=rec[i].Solution; solutiondescription=rec[i].Description; solutionsname=rec[i].Description+"-"+rec[i].Solution; /* Add the description-solution to the list only if the description or solution field is not null for the cases searched based on the input text */ if(solutionname!=null && solutiondescription!=null) { var solutionlist = document.getElementById("solutionlist"); var option = document.createElement("OPTION"); option.innerHTML = solutionsname; option.value = solutionsid; solutionlist.appendChild(option); } } }) } //Updates the solution to the solution field of the current case and changes the case status to closed Util.update=function() { solutiontext=document.getElementById("solutiontext").value; var config={ Entity:"Cases", APIData:{ "id": EntityIds[0], "Solution":solutiontext, "Status":"Closed" }, Trigger:[] } ZOHO.CRM.API.updateRecord(config) .then(function(data){ console.log(data) }) } // Closes the widget popup Util.cancel=function() { ZOHO.CRM.UI.Popup.close() .then(function(data){ console.log(data) }) } }) |
In the above code snippet, the input text keyed in is retrieved and passed as the Query parameter to the searchRecord API. The type parameter is passed as 'word', and the Entity parameter as 'Cases'. This searches across the Cases module for the input text and returns all the cases with the word present.
From the retrieved cases, the descriptions and solutions are fetched and populated into a select list. The user can have a look at the solutions and choose one if it resolves the current case issue.
The chosen solution is populated in the 'Enter solution here' textbox. The user can choose to edit the solution further according to their needs in the textbox and then click the 'Update Solution and close Case' button.
The updateRecord API will then update the solution entered to the solution field of the current case, and will change the status of the case to "Closed".
Sample Widget:
The user handles a case about a hardware issue. In the widget, they enter the word 'hardware' in the input field because it is a relevant word associated with the current case.
When the user clicks the 'Check for solutions' button, the searchRecord API returns all the descriptions and solutions involving 'hardware'. The user chooses a solution if it is relevant and makes further edits relevant to their case in the solution textbox. The 'Update Solution and close Case' button will update the solution to the solution field of the current case and close the ticket.
This was just an example, but there are many similar ways you can use the SearchRecord API to suit your specific business needs.
We hope you found this information useful. Keep following this space for more info!
SEE ALSO
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
Nanditha Somasundaram Somasundaram
Sticky Posts
Kaizen #217 - Actions APIs : Tasks
Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.Kaizen #216 - Actions APIs : Email Notifications
Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes areKaizen #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 the
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
how to add subform over sigma in the CRM
my new module don't have any subform available any way to add this from sigma or from the crmZoho Projects - Project Details on the Project Menu
Hi Project's team, I've helped may businesses setup and use Zoho Project and one thing I see time and time again is confusion on where to find the Project Details information. I would be much more intuitive if Project Details was on the menu before Dashboard.Zoho Projects - Add Feed to Project Tabs
Hi Projects Team, I'm working on a lightweight communications requirement for one of my customers in relation to communicating with their client users via Zoho Projects. I noticed that the Feed is only available in the Collaboration section, but you canFlow - Fetch info from drop down in another module
I am running into a road block which I thought would be a simple task. My goal - The account is assigned to a "route" which can be selected from a drop down menu and adds a tag to the account accordingly (easy enough). Now when I create a task for thisShow unsubscribed contacts ?
Hello, I would like to display the unsubscribed contacts. Unfortunately, I do not have this subscription type as described in the documentation (https://help.zoho.com/portal/en/kb/marketing-automation-2-0/user-guide/contacts/contact-management/articles/subscription-type-24-1-2024#Subscription_Type_field.)Zoho Developer Community Hackathon 2025 is LIVE!
Hey developers! It’s that time of the year again — the Zoho Developer Community Hackathon 2025 is officially open for registrations! If you’ve been waiting for a chance to stretch your skills, try something new, or finally bring that idea to life, thisConverted Leads Not Showing in Lead Reports
Converted leads are not showing in the Lead reports. How can I make converted leads visible in the report,Text widgets in dashboards
Having a text widget in a dashboard would help immensely. It would allow adding links to related documents, relevant CRM views, etc. It would allow adding explanations of the data displayed in the other widgets, about how to interpret them or about filtering.[Webinar] Zoho Writer for content creators and publishing houses
Managing multiple drafts, edits, and client reviews doesn't have to slow you down. Join our upcoming webinar to see how Zoho Writer helps content creators and publishing houses create, edit, and publish seamlessly—all in one place. You'll learn how to:Adding Reports to Portals
Is there a way to add Reports to portals so only the user can see report templates relevant to them?How to assign one Manual to multiple Spaces?
Hello, I have two spaces, one called tech knowledge and the other one called HR knowledge. I have a manual that is called HR tech. I want to assign this manual to HR knowledge and tech knowledge. How should I do that?Introducing VeriFactu Support in Zoho Books
Hello users, Spain has introduced the VeriFactu system under Real Decreto 1007/2023 to ensure integrity, traceability, and anti-fraud compliance in e-invoicing. Starting January 1, 2026, all B2B invoices must be reported to Agencia Estatal de AdministraciónHow can I assign courses to Spaces?
How can I make courses show up here in this space?:When will Zoho Learn be able to support SCORM files on the mobile app?
When I click the SCORM content, I just get a message saying it's not possible yet. Yet implies that it will be coming soon. All I'm asking for is a realistic timeline so I know whether or not to invest my time in using it. If it will be soon, then I willAnnouncing new features in Trident for Windows (v.1.35.6.0)
Hello Community! Trident for Windows just got better with an update that makes working with your emails even more efficient. Let’s dive into what’s new! Work with PST files more efficiently. You can now do more than just view mounted PST files. You canMarketing Tip #9: Track your traffic sources
Not all marketing channels work equally well. Knowing whether your visitors come from Google, Instagram, or email helps you focus on what actually drives sales. Try this today: Check your Zoho Commerce reports or connect Zoho PageSense to see your topGoogle Analytics import data inaccurate (as of October 11, 2025)
We have Zoho Analytics connected to GA4 to import daily event data. This has been running without issue for a couple of years. However, a month ago we started noticing discrepancies. All data until October 10 lines up perfectly - October 11 onward isZoho Recruit Slow and Freezing on all screens
We have had an issue with Zoho Recruit for weeks being extremely slow and at times freezing. We have 100 mega internet, and I went into each computer and updated the virtual memory so there is more available. Also restarted all computers daily. Still having the issues. Almost unable to work.Prevent accidental duplicate entry of Customer Ordersome
Zoho Support has confirmed that Zoho currently does not have any method (using Deluge, flow or any other method) to alert a user when a sales order has been entered twice using the same customer reference number (i.e. a duplicate). Most ERP platformsZoho Books | Product updates | November 2025
Hello users, We’ve rolled out new features and enhancements in Zoho Books. From translating email notification templates to the new transaction locking restrictions, explore the updates designed to enhance your bookkeeping experience. Making Tax DigitalInsert Image into Notebook page
Prior to today, I could add images to my notebook pages. Today when I tried to do this I got an error message that said something like, "There's been a problem on our end. Try again later." So, I've tried all the ways I know how, but I can't insert an【開催報告】名古屋 ユーザー交流会 Vol.2 2025/11/21 Zoho Analytics / Inventory で実現する在庫の"未来予測"
ユーザーの皆さま、こんにちは。コミュニティチームの中野です。 11/21(金)に名古屋 ユーザー交流会 を開催しました。 本投稿では、当日実施したセッションの様子及び投影資料をお届けします。 会場にて参加できなかった皆さまも、ぜひご参照ください。 （Zoho 社員セッションの登壇資料については、11/28(金)開催の東京回の開催報告で共有いたします） 今年2回目の開催となる名古屋 ユーザー交流会では、株式会社エンツナクリエイト 野末さんによる Zoho Analytics / InventoryIs 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 wouldImproved RingCentral Integration
We’d like to request an enhancement to the current RingCentral integration with Zoho. RingCentral now automatically generates call transcripts and AI-based call summaries (AI Notes) for each call, which are extremely helpful for support and sales teams.Edit Pinned Comments in Zoho Desk
It's great that private comments can now be pinned to the top of the ticket but what would be extremely helpful would be to allow for the pinned comment to be edited vs. having to find the comment in the ticket to edit it.Updating Secondary Contact (CCs)
We use Zoho Forms to capture the user request and integrated with Zoho Desk to raise tickets. Active Microsoft login is captured in our Zoho forms and registered as Primary contact in Zoho desk ticket. We also an have an option to raise ticket on behalfblank page after login
blank page after logging into my email account Thanks youWriterTh
After every space Writer goes to capital letters mode in my Android tablet. The cap mode stays till the second letter is typed in the word then it comes to normal mode.Zoho writer unable to merge documents to PDF with basic fonts in Hebrew or fonts from my computer
I created several forms that will be merged into PDF files through Zoho Writer and I am unable to receive the PDF in the basic fonts of the Hebrew language or in the fonts I have on my computer. The writer exports to PDF an exchange font that looks veryI have already created some Bots, Commands, and Widgets in Cliq, but I am still not seeing the “Create Extension” option in my account. Could you please help me enable or access this option?
Infinite loop of account verification
Hi I can't do anything on my zoho account. I always get this message Hi Sheriffo Ceesay As a security measure, you need to link your phone number with this account and verify it to proceed further. When ever I supply the details, it displays that the number is associated with another account. I don't have any other account on zoho so this is really annoying.How we cut CRM updates from ~20 minutes down to 2, our real workflow
Updating the Zoho CRM after every call used to be one of the biggest time sucks for our team. By the time you write your notes, clean them up, fill in the fields, and log everything properly… you’ve easily lost 15–20 minutes per call. We started experimentingArattai App Features Update
1. Offline Messaging & Sync Enable users to compose messages without internet and deliver them automatically via peer-to-peer methods (Bluetooth/WiFi Direct) when nearby users are available. This would be a game-changer for rural India with unreliableHow to add Product Add-Ons, Mandatory Forms, and Auto-Save Address in Zoho Commerce
Hi all, I need help setting up several behaviors in Zoho Commerce. I can’t find the correct configuration options, so I want to confirm whether these are supported or if there is a workaround. 1. Product-Specific Add-Ons (Example: GWB Subscription) WhenZohomail
Im trying to setup email address zohoPROBLEMA
Salve, non riesco a inviare email, e mi esce una tabela errore temporaneo. come posso risolvere il problema ?Forever FREE Business Email with Zoho Mail
Forever FREE Business Email with Zoho Mail: is it available?Weekly Tips : Make collaboration effortless with Whiteboard in Zoho Mail
Working with your team often means switching between emails, notes, and other applications just to explain an idea. Maybe you are trying to sketch a layout, plan a workflow, or quickly brainstorm ideas—with text alone, things can get confusing. So howFormula field number of days between 2 dates
Hi, I want to have a formula field which calculates the following: IF EndDate < TODAY and Oproep is true (this is a checkbox field) than EndDate - StartDate, otherwise TODAY - StartDate It should calculate the number of days How can I write this for'email address already exists'
I deleted a user from my organization and want to use the same email address that user had, but the email address seems to still exist somewhere as I get 'email address already exists' when I try and create it. I have deleted the entire organization andNext Page