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



      Zoho SalesIQ Resources



            Zoho TeamInbox Resources

              Zoho DataPrep Resources


                  Zoho CRM Plus Resources

                    Zoho Books Resources


                      Zoho Subscriptions Resources

                        Zoho Desk Resources

                          Zoho Projects Resources


                            Zoho Sprints Resources


                              Qntrl Resources


                                Zoho Creator Resources


                                  Zoho WorkDrive Resources




                                      Zoho Campaigns Resources

                                        Zoho CRM Resources

                                                    Design. Discuss. Deliver.

                                                    Create visually engaging stories with Zoho Show.

                                                    Get Started Now


                                                      Zoho Show Resources


                                                        Zoho Writer Writer

                                                        Get Started. Write Away!

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

                                                                  有料プランをご利用の方