Extension Pointers JS SDK Series #3: Delinking a related record in a Zoho CRM module from a widget

Extension Pointers JS SDK Series #3: Delinking a related record in a Zoho CRM module from a widget

In synchronization, it is important to be able to associate and dissociate the required data at the appropriate times. In our previous post, we mentioned the method to fetch related records in a Zoho CRM module from a widget. In this post, we will explain the process of delinking a related record for a Zoho CRM module from a widget, which is the reverse process to the previous post. Associating data between modules and establishing related records in your Zoho CRM is a common action, but you may sometimes no longer require the information from a particular related record. Instead of completely deleting the unnecessary related records from your Zoho CRM, you can perform a simple delinking process, and still retain the details in Zoho CRM. 

ZOHO.CRM.API.delinkRelatedRecord(config) is used to delink a record from its related list record details.

Syntax:

ZOHO.CRM.API.delinkRelatedRecord(config)

Here config is the configuration object constructed with the following details:

Configuration Object

Name
Type
Description
Entity
String
API Name of the module.
RecordID
String
RecordID of the entity whose associated details are required.
RelatedListName
String
API Name of the relatedList of the entity.
RelatedRecordID
String
Related Record ID.

Example

ZOHO.CRM.API.delinkRelatedRecord({Entity:"Contacts",RecordID:"43426879776433",RelatedList:"Deals",RelatedRecordID:"7678567456858"})
.then(function(data){
console.log(data)
})


Here, the Deal (related list for the Contact module) with deal ID "7678567456858" is associated with the Contact with the recordID "43426879776433". In the above example, the deal's record is delinked from the deals associated with the contact using ZOHO.CRM.API.delinkRelatedRecord.

Scenario:

Let's consider a scenario. Your wireless fidelity business, which is a service provider for wireless network connection, uses Zoho CRM. The Contacts module holds business clients who have bought your connection and the Deals module holds deals (connection plan) that are associated with the client along with the deal status.

Let's imagine a situation in which a customer chooses to unsubscribe from their current plan and move to another plan or move to another service provider. Now you decide to delink the related information from the relevant record in the Contacts module without completely deleting the information from your CRM. You can perform this action by delinking the specific deal associated with the contact. Let's see how ZOHO.CRM.API.delinkRelatedRecord helps to achieve this from a widget.

Code Snippet:

Util={};
function initializeWidget()
{
// Event Listener triggered when the entity page is loaded
ZOHO.embeddedApp.on("PageLoad",function(data)
{
//Fetching the entity ID of the current page that is loaded
contactid=data.EntityId;
entityname=data.Entity;  

/*Fetching all the deals that are related with the contact using the getRelatedRecords method. Passing the value of RelatedList as Deals and Entity as Contacts to the getRealtedRecords method.*/  
ZOHO.CRM.API.getRelatedRecords({Entity:"Contacts",RecordID:contactid,RelatedList:"Deals",page:1,per_page:200})
.then(function(data){
temp=data;
rec=data.data;
console.log(data);
$('#dealidlist').empty();
//Looping through the deals
for (i = 0; i < rec.length; i++) 
{
/*Creating a list called dealidlist. Populating the dealidlist with the names of all the deals associated with the contact, when the GetDeals button is clicked*/
dealid=rec[i].id;
dealname=rec[i].Deal_Name;
var dealidlist = document.getElementById("dealidlist");
var option = document.createElement("OPTION");
option.innerHTML = dealname;
option.value = dealid;
dealidlist.appendChild(option);
}
})
//Functionality of Delink deals button
Util.delink=function()
{
/*The deal selected from the dealidlist is passed as RelatedRecordID value, to the delinkRelatedRecord method. Delinking the deal selected from the dealidlist and thereby dissociating it from the contact*/ ZOHO.CRM.API.delinkRelatedRecord({Entity:"Contacts",RecordID:contactid,RelatedList:"Deals",RelatedRecordID:document.getElementById("dealidlist").value})
.then(function(data){
console.log(data)
})
ZOHO.CRM.UI.Popup.close()
.then(function(data){
console.log(data)
})
}; 
//Functionality of the cancel button
Util.cancel=function()
{
//closes the widget window
ZOHO.CRM.UI.Popup.close()
.then(function(data){
console.log(data)
})
};
})
//Initializing the widget
ZOHO.embeddedApp.init();
}

Click the Manage Connections button (available in the contact's detail page) associated with the widget to open the widget screen.



Choose the deal you want to delink from the contact and click Delink Deal. The deal will now be delinked from the customer.



This is an example of how you can use ZOHO.CRM.API.delinkRelatedRecord to delink a related record from a Zoho CRM contact from your widget. You can use this SDK according to your business needs to perform operations efficiently from your widget. We hope you found this information useful. Keep following this space for more tips.

SEE ALSO



    Access your files securely from anywhere

        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

                                                              • 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
                                                              • Kaizen #222 - Client Script Support for Notes Related List

                                                                Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore how
                                                              • 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 are


                                                              Manage your brands on social media



                                                                    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

                                                                                        • 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

                                                                                                                • CRM 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 files
                                                                                                                • Anyone worked out how to export or screengrab a full heatmap?

                                                                                                                  I'd love to be able to include a copy of a heatmap in a report but can't work out how to grab the whole thing as there doesn't appear to be an export function? Thanks in advance.
                                                                                                                • Introducing Built-in Telephony in Zoho Recruit

                                                                                                                  We’re excited to introduce Built-in Telephony in Zoho Recruit, designed to make recruiter–candidate communication faster, simpler, and fully traceable. These capabilities help you reduce app switching, handle inbound calls efficiently, and keep every
                                                                                                                • Sender Email Configuration Error.

                                                                                                                  Hello Team, Hope you are all doing well. We are in the process of creating the Zoho FSM environment in the UAE. When we try to add the sender email address “techsupportuae@stryker.com”, we receive the error message: “Error occurred while sending mail
                                                                                                                • Es posible cambiar el lenguaje de los modulos del ASAP?

                                                                                                                  Es posible cambiar el lenguaje de estos textos? Tengo Zoho configurado en español pero aun así me muestra estos textos en ingles:
                                                                                                                • Auto-publish job openings on my Zoho Recruit Careers Website

                                                                                                                  I have developed a script using the Zoho Recruit API that successfully inserts new jobOpening records to my Zoho Recruit website, but my goal is to auto-publish to the Careers Website. The jobOpening field data shows two possible candidates to make this
                                                                                                                • [Free webinar] Custom domains for portals in Zoho Creator - Creator Tech Connect

                                                                                                                  Hello everyone, We’re excited to invite you to another edition of the Creator Tech Connect webinar. About Creator Tech Connect The Creator Tech Connect series is a free monthly webinar featuring in-depth technical sessions designed for developers, administrators,
                                                                                                                • Remove my video

                                                                                                                  Hi, How can I remove my video so that I don't have to see myself. It's weird so I always remove my own video from what I see but cannot find this feature here. Thanks!
                                                                                                                • Marking a meeting 'done'.

                                                                                                                  I would like to somehow mark a meeting 'done' and placed under the contact's page rather than deleting it and having no record of it. Am I missing a button that does this?
                                                                                                                • Add Lookup Field in Tasks Module

                                                                                                                  Hello, I have a need to add a Lookup field in addition to the ones that are already there in the Tasks module. I've seen this thread and so understand that the reason lookup fields may not be part of it is that there are already links to the tables (
                                                                                                                • Super Admin Logging in as another User

                                                                                                                  How can a Super Admin login as another user. For example, I have a sales rep that is having issues with their Accounts and I want to view their Zoho Account with out having to do a GTM and sharing screens. Moderation Update (8th Aug 2025): We are working
                                                                                                                • Cannot find zpuid for Zoho Projects user

                                                                                                                  I'm using the Zoho Projects v3 API to create a task. The task is created successfully, but in order to assign the task owner, the "Create a Task" API also requires the zpuid of the task owner. Unfortunately I cannot find any user-related API calls that
                                                                                                                • Allocating inventory to specific SO's

                                                                                                                  Is there a way that allocate inventory to a specific sales order? For example, let's say we have 90 items in stock. Customer 1 orders 100 items. This allocates all 90 items to their order, and they have a back order for the remaining 10 items which could
                                                                                                                • Can Zoho Marketing Automation send OTP codes via WhatsApp during user registration?

                                                                                                                  The flow I would like to implement is: A user signs up in the mobile app and enters their phone number. The system generates a one-time verification code (OTP). The OTP is sent to the user via WhatsApp message. The user enters the code in the app to confirm
                                                                                                                • Incorrect Functioning of Time Logs API (Version 3)

                                                                                                                  We need to fetch the list of time logs for each task for our company internal usage. We are trying to achieve it by using the next endpoint: https://projects.zoho.com/api-docs#bulk-time-logs#get-all-project-time-logs Firstly, in the documentation the
                                                                                                                • Partial payments for retainer invoices

                                                                                                                  When a customer does not pay the entire retainer invoice there is no way to apply a partial payment. PLEASE add this function.
                                                                                                                • Can I export to PDF in Zoho Learn

                                                                                                                  I have seen help pages where export to pdf options are available but I do not see that option available from the application. I see that exprt is available in my free trial version but that is only to html pages. I need to be able to export my manuals
                                                                                                                • Service line items

                                                                                                                  Hello Latha, Could you please let me know the maximum number of service line items that can be added to a single work order? Thanks, Chethiya.
                                                                                                                • Sending emails via Books

                                                                                                                  Anyone else getting similar problems recently ??..... Hi, Your message to the following recipient was not delivered. Please find the details below.  Bounce Details: Bounced Address : someone@google.com Bounce Reason : other ; Status : 5.0.0 (undefined status) ; Daignostic-Code : smtp;542 someone@google.com Rejected ; Bounced Time : Sep 05, 2017 06:37 PM BST Regards, Zoho Team The email addresses were fine only a few days ago but are now being rejected ?
                                                                                                                • PDF Generator Upgrade

                                                                                                                  Hi Team, What will happen if I don't make any changes for existing template. Zoho just ask us upgrade but haven't tell the benefit. Zoho Corporation
                                                                                                                • No Need To Fix Something That Is Working

                                                                                                                  Zoho Books is a great financial tool which helps businesses to become more efficient and productive with day-to-day operations. As such, every change, upgrade, improvement needs to be carefully thought before implemented in the software and I'm sure Zoho
                                                                                                                • Total Cost in reports showing zero

                                                                                                                  The image below shows my issue. The column Total Cost should show the cost to our company based on hours logged and the employee's rate. For instance, if the person working on Subtask 1 is paid 20/hr, then Total Cost should display $160 ($20x8 logged
                                                                                                                • Zoho Books (and other finance suite apps) - Retrospective Linking of Invoice and Sales Orders to Quotes.

                                                                                                                  In some cases, Quotes and Invoies may be created sperately instead of using the convert feature. In this feature request I am asking for the Finance Suite team to consider adding a lookup field to reference the quote on Invoices and Sales Orders, or some
                                                                                                                • Bring real app analytics into Zoho Creator apps with Zoho Apptics

                                                                                                                  We’re kicking off the year with a release we’ve been looking forward to for a long time. After being in the works for a while, Zoho Creator and Zoho Apptics are now officially integrated, bringing in-depth product analytics directly into the Zoho Creator
                                                                                                                • ZohoMail's outbound webhook sends incorrect folderId and messageId

                                                                                                                  I used a webhook (outbound) from within ZohoMail to send message details when a new message arrives that meets specific criteria. I received this data correctly. Now I want to get the attachment from this email message. When I made an api call using folder
                                                                                                                • Use URL field to populate Image in a Email Template

                                                                                                                  We have two records Record 1: Appointments (with a Lookup to Doctors module) Related Record 2: Doctors (with a URL field that is an image of the doctor) We would like to populate a CRM email template with the image of the URL field for the related doctor
                                                                                                                • Looking for Guidance on Building a Zoho Website

                                                                                                                  I'm exploring the possibility of building a custom website with specific features using Zoho as an alternative platform. My goal is to create something similar to https://gtasandresapk.com , with the same kind of functionality and user experience. I'd
                                                                                                                • Ability to add VAT to Retainer Invoices

                                                                                                                  Hello, I've had a telephone conversation a month ago with Dinesh on this topic and my request to allow for the addition of VAT on Retainer Invoices.  It's currently not possible to add VAT to Retainer Invoices and it was mutually agreed that there is absolutely no reason why there shouldn't be, especially as TAX LAW makes VAT mandatory on each invoice in Europe!   So basically, what i'm saying is that if you don't allow us to add VAT to Retainer Invoices, than the whole Retainer Invoices becomes
                                                                                                                • Zoho Bookings Forge: A hands-on workshop series

                                                                                                                  Hello all! We’re hosting a five-part, hands-on workshop series to help you optimize Zoho Bookings for your business. In these sessions, we’ll cover key features, practical use cases, and clear steps to get started or improve your current setup. Here are
                                                                                                                • Introducing parent-child ticketing in Zoho Desk [Early access]

                                                                                                                  Hello Zoho Desk users! We have introduced the parent-child ticketing system to help customer service teams ensure efficient resolution of issues involving multiple, related tickets. You can now combine repetitive and interconnected tickets into parent-child
                                                                                                                • Update Existing Records greyed out in Free Version

                                                                                                                  Trying to update records from an Excel sheet, and not getting the option to update. Only option is to add as new accounts. All documentation I can see says update should be an option! Accounts, Leads, Contacts, all the same.
                                                                                                                • Help with deluge script

                                                                                                                  Hi Community, this is my first Deluge script. I've pieced it together from reading various articles I want to use it in a workflow to 1 Convert a lead to a contact 2. Create a record in a custom module Below is what I have got so far but it does not fire
                                                                                                                • Introducing Workqueue: your all-in-one view to manage daily work

                                                                                                                  Hello all, We’re excited to introduce a major productivity boost to your CRM experience: Workqueue, a dynamic, all-in-one workspace that brings every important sales activity, approval, and follow-up right to your fingertips. What is Workqueue? Sales
                                                                                                                • Delete button

                                                                                                                  Hi, The delete button were hide into the three dot button. Can I display outside? why Zoho make this update?
                                                                                                                • Zoho Vault CLI for Developers and Automations

                                                                                                                  Hi everyone, If you're managing credentials in scripts, CI/CD pipelines, or automation workflows, Zoho Vault's Command Line Interface (CLI) can help you securely access and manage secrets directly from your terminal. Zoho Vault was launched in 2013 as
                                                                                                                • On Edit Validation Blueprint

                                                                                                                  Hello, I have a notes field and a signature field. When the Approve button is clicked, the Signature field will appear and must be filled in. When the Reject button is clicked, the Notes field will appear and must be filled in. Question: Blueprint will
                                                                                                                • Server-based Appication API access for Social, Sites, Flow, Pages.

                                                                                                                  Hello, I am trying to hook up API access for a number of apps and I have hit a wall trying to add these scopes to the API feed. We cannot find the correct way to list the scope for these Zoho apps; Social, Sites, Flow, Pages. Error on web-page comes back
                                                                                                                • Zoho Subscriptions -- Zoho Commerce integration

                                                                                                                  Is there integration between Zoho Subscriptions and Zoho Commerce? I would like to create subscription plans in Zoho Subscritpions and list them for on my Zoho Commerce store.
                                                                                                                • Synching changes to Stripe when changes are made in Zoho Billing

                                                                                                                  We have a situation where we have merged customers in Zoho BIlling and then found out later that the payment in Stripe was not updated and still associated with the old customer record. The card gets updated and billed, but that payment is still associated
                                                                                                                • How can I link Products in a Deal Subform to the Products Module

                                                                                                                  Hello, I have a pricing subform on our Deals page and use a lookup field to associate a product with each line. I want to be able to look at a product page within the Products module and see a list of the deals connected to that product. I have this working
                                                                                                                • Next Page