Extension Pointers - JS SDK Series#7: Managing records, handling attachments, and adding notes from a widget

Extension Pointers - JS SDK Series#7: Managing records, handling attachments, and adding notes from a widget

Zoho CRM JS SDK supports APIs that help manage records, attach files, and add notes to a record, all from within the widget itself. The term record refers to the detailed information about an individual entity in the Zoho CRM module. Attachments and notes are additional information that add extra context to the record details for a variety of purposes, including sales, SLAs, proofs, etc. 

Let's first look at the syntax of each API followed by a working example demonstrating the purpose of the different APIs.

ZOHO.CRM.UI.Record
Syntax:

This API can help with multiple functionalities in managing records, such as:
➤ ZOHO.CRM.UI.Record.create(data) - open CreatePage of the specified Record.
➤ ZOHO.CRM.UI.Record.edit(data) - open EditPage of the specified Record.
➤ ZOHO.CRM.UI.Record.open(data) - open DetailPage of the specified Record.

Here, data refers to the configuration object of 'object' type.

Configuration Object

Name
Type
Description
Entity
String
SysRefName of the module.
RecordID
String
The ID of the record to open or edit.
Target
String
Allowed values "_blank". To open the create/edit/open page of the record in a new tab.

ZOHO.CRM.API.attachFile

This API is used to attach files to a record in a module.

➤ The attachment will appear under the 'Attachments' related list section of the record.
➤ The maximum attachment limit for a record is 100MB.
➤ All attachment formats are supported except exe files.
➤ The API can be used in all modules that support the 'Attachments' section.

Syntax:

ZOHO.CRM.API.attachFile(config)

Here, config refers to the configuration object.

Configuration Object

Name
Type
Description
Entity
String
SysRefName of the module.
RecordID
String
The record ID for which the attachment is to be associated.
File
Object
File object to be attached.

The file object holds two properties.

Name
Type
Description
Name
String
The name of the file.
Content
Object
The file content.


ZOHO.CRM.API.addNotes

This API is used to add notes to a specific record in a module.

Syntax:

ZOHO.CRM.API.addNotes(config)

Here, config refers to the configuration object.

Configuration Object

Name
Type
Description
Entity
String
SysRefName of the module.
RecordID
String
The record ID for which the note is to be associated.
Title
String
The title for the note.
Content
String
The note content.

Consider a simple scenario where a user is running an ecommerce store using their Zoho CRM account. Their store offers a wide range of hardware and software products. There are also certain discount deals that are offered for several products in accordance with their sales strategy. Let's say that, after a good turnover, the user wants to delink a product from a certain discount deal. Besides delinking, the user would like to attach some of the relevant files and add notes to the deal in order to provide additional information on the reason for the delinking. The user would also like to view the full details of the product before delinking it from the deal. Let's see how all these features can be done from a widget.



Record.js code snippet:

Util={};
var EntityIds;
var EntityName;
var temp;

//Subscribe to the EmbeddedApp onPageLoad event before initializing the widget 
ZOHO.embeddedApp.on("PageLoad",function(data)
{
EntityIds=data.EntityId[0];
EntityName=data.Entity;

//Getting the product-related details of the deal using getRelatedRecords API
ZOHO.CRM.API.getRelatedRecords({Entity:EntityName,RecordID:EntityIds,RelatedList:"Products",page:1,per_page:200})
.then(function(data){
temp=data;
rec=data.data;
console.log(data);
$('#prodidlist').empty();

//Looping through the products
for (i = 0; i < rec.length; i++) 
{

/*populating the prodidlist list with the product names of all the products associated with the deal*/
prodid=rec[i].id;
prodname=rec[i].Product_Name;
var prodidlist = document.getElementById("prodidlist");
var option = document.createElement("OPTION");
option.innerHTML = prodname;
option.value = prodid;
prodidlist.appendChild(option);
}

})  

/*Viewing the complete details page of the selected product from the prodidlist using the record open API*/
Util.view=function()
{
ZOHO.CRM.UI.Record.open({Entity:"Products",RecordID:document.getElementById("prodidlist").value,Target:"_blank"})
.then(function(data){
console.log(data)
})
}  

Util.delink=function()
{

//Delinking the product selected from the product list and thereby dissociating it from the deal 
ZOHO.CRM.API.delinkRelatedRecord({Entity:EntityName,RecordID:EntityIds,RelatedList:"Products",RelatedRecordID:document.getElementById("prodidlist").value})
.then(function(data){
console.log(data)
})
var filesToLoad = document.getElementById("fileInputTag").files;
var filename=filesToLoad[0].name;
if(filesToLoad)
{
var file = filesToLoad[0];
ZOHO.CRM.API.attachFile({Entity:EntityName,RecordID:EntityIds,File:{Name:filename,Content:file}})
.then(function(data){
console.log(data);
});
}

// Adding the input value provided as a note to be associated with the deal  
ZOHO.CRM.API.addNotes({Entity:EntityName,RecordID:EntityIds,Title:"Delink Notes",Content:document.getElementById("notes").value}).then(function(datas){
console.log(datas);
});  

ZOHO.CRM.UI.Popup.close()
.then(function(data){
console.log(data)
})
}; 
})

  1. In the above code snippet, the entity ID and entity name are fetched on page load.
  2. The retrieved ID and entity name are then passed to the 'getRelatedRecords' API to fetch the complete 'Products' related list details of the specific deal.
  3. The products associated with the deal are then populated into a select list so the user can choose the product they would like to delink.
  4. The ZOHO.CRM.UI.Record.open API is used with the target property set to "_blank" to open the detail page of the chosen product. This displays the complete details of the product in a new tab upon clicking the 'View product details' button in the widget.
  5. Finally, upon clicking the 'Delink' button, three functions occur. Namely:
  • The chosen product is delinked from the associated deal.
  • The attachment file chosen is attached and will be available in the 'Attachments' section of the record using the ZOHO.CRM.API.attachFile API.
  • The notes provided by the user will be added to the notes section using the ZOHO.CRM.API.addNotes API.


The product is now delinked from the deal. The attachment is added under the 'Attachments' section, and the note is added under the 'Notes' section.



As stated in the above scenario, the user can choose the product they want to delink, attach a document, and add a note that is relevant to the delinking process, all from within a widget.

There are multiple APIs in the Zoho CRM JS SDK that serve and help to build extensions efficiently. Please refer to our JS SDK series for posts on other API functionalities and keep track of this space for more information.


SEE ALSO



    Access your files securely from anywhere


            Zoho FSM Video Tutorials


                  All-in-one knowledge management and training platform for your employees and customers.






                                        Zoho Developer Community




                                                              • Desk Community Learning Series


                                                              • Digest


                                                              • Functions


                                                              • Meetups


                                                              • Kbase


                                                              • Resources


                                                              • Glossary


                                                              • Desk Marketplace


                                                              • MVP Corner


                                                              • Word of the Day


                                                              • Ask the Experts



                                                                        • Sticky Posts

                                                                        • Announcing the new SKILL.md for Zoho CRM and the updated OAS repository!

                                                                          We are introducing a new zoho-crm skill to make working with Zoho CRM Developer tools (like APIs, functions, widgets, client scripts, queries etc) easier and faster, with the help of AI in your preferred AI harness like Claude Code, Codex, Cursor, VSCode
                                                                        • Kaizen #261 : Using Zoho CRM Skill to generate complex COQL queries

                                                                          Hello everyone, In the previous Kaizen posts, we introduced the zoho-crm SKILL.md and discussed how it can help you when you are working with Zoho CRM APIs and Client Script. In this Kaizen, we will focus on using the Zoho CRM `SKILL.md` with GitHub Copilot
                                                                        • Kaizen #256 - Build an Arrival Readiness Web Tab in Zoho CRM

                                                                          Hi everyone! Welcome back to the Kaizen series! In the post, we discuss a use case in hospitality industry: how an Arrival Readiness web tab widget can be used to let reception staff identify and resolve issues before arrival of guests. Use case In the
                                                                        • 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.
                                                                        • Kaizen #226: Using ZRC in Client Script

                                                                          Hello everyone! Welcome to another week of Kaizen. In today's post, lets see what is ZRC (Zoho Request Client) and how we can use ZRC methods in Client Script to get inputs from a Salesperson and update the Lead status with a single button click. In this


                                                                        Manage your brands on social media



                                                                              Zoho TeamInbox Resources



                                                                                  Zoho CRM Plus Resources

                                                                                    Zoho Books Resources


                                                                                      Zoho Billing 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

                                                                                                          Get Started. Write Away!

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

                                                                                                            Zoho CRM コンテンツ


                                                                                                              Nederlandse Hulpbronnen


                                                                                                                  ご検討中の方




                                                                                                                            • Recent Topics

                                                                                                                            • Live connection to DS files in Zoho Creator / ChatGPT

                                                                                                                              As an idea, we are using ChatGPT to build with Zoho Creator (outside of Zia), which is works brilliantly to assist write deluge, provide test suggesitons etc. Currently we are uploading the DS files which are very point in time, it would be great to have
                                                                                                                            • Zoho Forms - Feature Request - Embed iFrame or Dynaic URLs in Description fields

                                                                                                                              Hi Zoho Forms team, I'm working with a client who uses Zoho Forms internally to collect information over the phone from potential work placement candidates. At the end of the form, the candidate needs to be booked in for an induction, which we've configured
                                                                                                                            • New in Office Integrator: Add text, diagrams, and drawings to your spreadsheet

                                                                                                                              Hi users, We are pleased to introduce the Shapes feature in Zoho Office Integrator's spreadsheet editor. It lets users create visual elements; including simple shapes, text boxes, freehand drawings, and structured diagrams; directly within the spreadsheet.
                                                                                                                            • Highlight what matters, erase what doesn’t in PDFs

                                                                                                                              When reviewing PDFs or preparing them for sharing, two things often come up: you want to draw attention to what’s important, and you want to hide what isn’t. Zoho PDF Editor gives you both capabilities in one place with its highlight and erase tools.
                                                                                                                            • WorkDrive Desktop Sync Is Being Deprecated: Move to WorkDrive TrueSync for a Smarter Experience

                                                                                                                              Hi everyone, We are excited to share a better, smarter way to access and manage your files directly from your computer! We’re transitioning from our legacy Desktop Sync app to WorkDrive TrueSync, designed to give you faster performance,greater flexibility,
                                                                                                                            • Zoho Desk API returning 403 SCOPE_MISMATCH for Ticket Search API

                                                                                                                              Hello Zoho Support Team, We are experiencing an authorization issue with the Zoho Desk Ticket Search API. Our integration was working correctly yesterday, but we are now receiving the following error when calling the Search Tickets endpoint: API: GET
                                                                                                                            • 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()
                                                                                                                            • Introducing the Zoho Campaigns MCP server

                                                                                                                              Hello everyone, We are pleased to announce that Zoho Campaigns is now available in Zoho MCP. You can now connect your Zoho Campaigns organization to AI tools such as Claude, ChatGPT, GitHub Copilot in VS Code, and Cursor, and manage your email marketing
                                                                                                                            • SubForm Custom Sort - Deluge Workflows

                                                                                                                              I have been experimenting with the Custom Order function of Subforms, it works beautifully within the subform itself and retains the sorting order. However, I need to be able to iterate through the records in Deluge using the sort order (The usage case
                                                                                                                            • How to embed Google Analytics GA4 tracking on a standalone Public Page (outside Customer Portal)?

                                                                                                                              Hi, Is there an official or recommended way to embed Google Analytics (GA4) tracking directly onto a standalone public Zoho Creator Page (outside of a Customer Portal)? I’m considering using an invisible Custom JS Widget as a workaround, but I’d love
                                                                                                                            • Bank feeds automation is broken - requires manual intervention and authentication

                                                                                                                              Yodlee supports Australian Open Banking CDR protocols natively, but Zoho Books' implementation is still triggering legacy screen-scraping MFA blocks on CBA and other business banking accounts. When will Zoho update its Australian bank feed pipeline to
                                                                                                                            • Cannot Access Subform Display Order in Deluge

                                                                                                                              As highlighted in this community post, we still have to deal with the significant limitation of not being able to access the user-sorted order of subform rows through Deluge. This creates a major disconnect between the UI capabilities and backend automation,
                                                                                                                            • Process FOR loop for subform items in the order of the manual sorting

                                                                                                                              Hi Guys, I have searched everywhere and tried everything, but I still not able to resolve one particular challenge. I have a subform in my Invoice with rows for each item. I made it so that we can change the order of the items manually. I need to be able
                                                                                                                            • Augmenting subform capabilities

                                                                                                                              Greetings, everyone! Finally, the day has come for us to announce some of the most anticipated, requested, and exciting updates to subforms in Zoho Creator. As you're aware, subforms are an integral part of Creator forms, as they help in establishing
                                                                                                                            • Build appointment scheduling into your vibe-coded apps with Zoho Bookings

                                                                                                                              Exploring vibe coding? Wondering how an app built with AI can handle appointment scheduling? Join our upcoming live webinar to discover how Zoho Bookings APIs can help connect applications to scheduling capabilities. Here's what we'll explore: • Show
                                                                                                                            • Is there a way to make Reason For Loss field mandatory at Closed Lost stage?

                                                                                                                              Hi guys, Reason For Loss system picklist appears on Verify Details page but it is not mandatory so as a result, AEs tend to omit it (leave at default value -None-). Is there a way to make it mandatory at Closed Lost? I tried layout rule but this field
                                                                                                                            • Cannot reorder fields in Page Layout in Expenses and Purchase Requests

                                                                                                                              It is very inconvenient that the custom fields in Page Layout cannot be re-ordered. The only way is to remove the fields and re-create them; however, it is impractical. This would affect the reports and dashboards we are having. Not able to re-order the
                                                                                                                            • Request for Zoho Desk Version and Module Details

                                                                                                                              Kindly help us confirm the version of Zoho Desk currently being used in our portal, along with the module/edition name. We require this information urgently for our internal documentation.
                                                                                                                            • How to customize the displayed name of contacts in Trident?

                                                                                                                              Hello, For work purposes, I sort different customers into different folders, and I also change their display names in Contacts so I can easily recognize them later. However, Trident doesn’t seem to support this. Even after I edit a contact’s name in Contacts,
                                                                                                                            • User and mailbox reports in Zoho Mail: Review account status, storage, and login activity of users

                                                                                                                              Administrators often need answers to questions such as which users have never logged in, whose storage is almost full, or which mailboxes are accessed through POP or IMAP. The User and Mailbox reports in the Zoho Mail Admin Console provide these details
                                                                                                                            • ZOHO CRM APP - SALESINBOX

                                                                                                                              Is it possible to access SALESINBOX in the CRM MOBILE APP
                                                                                                                            • Unbundle feature for composite items

                                                                                                                              We receive composite items from our vendors and sell them either individually or create other composite items out of them. So, there is a lot of bundling and unbundling involved with our composite items. Previously, this feature was supported in form
                                                                                                                            • Tip #96 – See more of the remote screen with Virtual Monitor – 'Insider Insights'

                                                                                                                              Hello Zoho Assist Community! Say you're supporting a device that has no monitor attached, like a server in a closet or a kiosk PC. You connect, and the screen is tiny, blurry, or distorted. Text overlaps and windows end up in odd places. Troubleshooting
                                                                                                                            • Understanding transactional channels in Zoho CPaaS

                                                                                                                              Every interaction with a business creates an opportunity to communicate.Whether it's welcoming a new user, confirming a payment, sharing an order update, or verifying a login, timely communication keeps users informed and connected. But how do businesses
                                                                                                                            • Autoscan Settings

                                                                                                                              I saw that autoscan is now included in my plan which is great however when I import pdf invoices from my main supplier which contain inventory lines and some also include shipping charges the autoscan doesn't match any of the items and also misses the
                                                                                                                            • How to resubscribe to email after using unsubscribe link in Zoho

                                                                                                                              I was testing the unsubscribe link feature from our contacts module in ZohoCRM and I sent my personal email a version of an email template with the default embedded unsubscribe link to see if it would utilize the "Email Opt Out" field to track un-subscription.
                                                                                                                            • WhatsApp Calling Integration via Zoho Desk

                                                                                                                              Dear Zoho Desk Team, I would like to request a feature that allows users to call WhatsApp numbers directly via Zoho Desk. This integration would enable sending and receiving calls to and from WhatsApp numbers over the internet, without the need for traditional
                                                                                                                            • [ZohoDesk] Improve Status View with a new editeble kanban view

                                                                                                                              A kanban view with more information about the ticket and the contact who created the ticket would be valueble. I would like to edit the fields with the ones i like to see at one glance. Like in CRM where you can edit the canvas view, i would like to edit
                                                                                                                            • No access to contact categories in Zoho Mail Apps

                                                                                                                              I have set up a number of contact categories for my organization. When I compose an email using a web browser these categories are visible. When I compose an email using your Android or iOS Apps no contact categories are visible. Is this expected? If
                                                                                                                            • Zoho Plug In

                                                                                                                              Is there anyone out there who is able to use it? I have seen lots of problems posted, unable to get any satisfactory suppport at the moment!  I would be really appreciate hearing from users that have it installed and working, my team are loosing belief it will ever work. Be great to hear from those that have a more positive experience
                                                                                                                            • Outlook to Zoho sync

                                                                                                                              I am the admin for our company and I have (1) single user that is having difficulties with her emails syncing. I have found where the problem is, but I don't know 100% if what is happening is how the plug-in works or if it's a setup issue. My boss created
                                                                                                                            • Cant' find the CRM plug in for outlook

                                                                                                                              I want to be able to tag emails that I have received into accounts. But I can't find the plug in for out look in the other apps section.  Where can I download it from?
                                                                                                                            • Problems with Zoho CRM Microsoft Outlook Plug-In (Add-On)

                                                                                                                              I am having problems with the Zoho CRM Microsoft Outlook Plug-In.  I was able to install and setup the Plug-In correctly I believe in Microsoft Outlook, but contacts are now being created in Zoho CRM when an email is sent from MS Outlook.  A contact is created and appears under Contacts in Zoho CRM but no other information is populated in the fields; for instance only the name is there (for instance "rfairley" ) which matches the beginning of their email address; but no phone numbers.    Also, other
                                                                                                                            • zoho for outlook

                                                                                                                              it would be woderfull to be able to add an email to a case, just as it is possible to add an email to a potential Vincent
                                                                                                                            • Mail Addon issue

                                                                                                                              Hi, I am trying  to make the mail add on feature work without clutter. The issues is that all emails from the contact are being listed in every opportunity that contact is involved in/ linked to.  I want to filter out the emails that are not relevant to the opportunity. It is ok to have all the mails of a contact under in the contact module. But under the opportunity it shall show only the relevant emails. Is there a way i could do this? Atleast if I could manually assign or amend the listed emails
                                                                                                                            • Eliminate duplicate tickets in one department using Email Deduplication ​

                                                                                                                              Hello everyone, A department can have multiple email addresses designed for different purposes for example, support@zpad.com and help@zpad.com. When a customer sends an email or thread response to both addresses, or includes both in the To, CC, or BCC
                                                                                                                            • "Pinning" a Note

                                                                                                                              It would be really helpful to have a way to "Pin" a note to the top of the notes section. This is really important when you have something important about someone and do not want the note to get buried farther and farther down the note stream. For instance:
                                                                                                                            • Feature Request - Copy Reschedule Link

                                                                                                                              Hi Bookings Team, I had a client contact me today, to let me know that she can't make a meeting she booked this week. I can't remember if I included a reschedule link in email notifications, but I was thinking that it would be great if I could just open
                                                                                                                            • Issue While Rescheduling Interviews in Zoho Recruit

                                                                                                                              Dear Zoho Support Team, We are facing an issue with the Interview Rescheduling functionality in Zoho Recruit integrated with Microsoft Teams. Problem Description When an interview is rescheduled through Zoho Recruit: The new interview is created successfully
                                                                                                                            • Enhancement Request for Job Publishing Management in Zoho Recruit

                                                                                                                              Provide a centralized view to Publish/Unpublish job openings across: - Job Portals - Career Portal - Employee Referral Portal Add filters to view job openings based on: Published to Career Portal Published to Employee Referral Portal Published to specific
                                                                                                                            • Next Page