Request Details

Request URL

{api-domain}/crm/{version}/{module_api_name}/{record_id}/{related_list_api_name}/{related_record_id}

To delete multiple related records:
{api-domain}/crm/{version}/{module_api_name}/{record_id}/{related_list_api_name}?ids={comma_separated_related_record_ids}

Supported relations

Campaigns - to - Leads, Contacts
Products - to - Leads, Accounts,
Contacts, Potentials, Price Books

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.modules.ALL
(or)
scope=scope=ZohoCRM.modules.{module_name}.{operation_type}

Possible module names

leads, deals, contacts, accounts, products, campaigns, and pricebooks

Possible operation types

ALL - Full access to records
WRITE - Edit related records
DELETE - Delete related records

Parameters

  • idsstring, mandatory when delinking multiple related records

    Specify comma separated related record IDs.

Note
  • You can delete a maximum of 100 related records through an API call, that is, you can specify a maximum of 100 related record IDs in the request URL.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v2.1/Campaigns/3652397000000327001/Contacts?ids=3652397000000925128,3652397000000649013"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
3.0.08.0
CopiedString moduleAPIName = "Leads";
Long recordId = "3477061000005177002";
String relatedListAPIName = "Products";
List<Long> relatedListIds = new ArrayList<Long>(Arrays.asList(3477061000005919001L, 3477061000005917011L));

//Get instance of RelatedRecordsOperations Class that takes relatedListAPIName, recordId and moduleAPIName as parameter
RelatedRecordsOperations relatedRecordsOperations = new RelatedRecordsOperations(relatedListAPIName, recordId, moduleAPIName);

//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();

for (Long relatedListId: relatedListIds) {
    paramInstance.add(DelinkRecordsParam.IDS, relatedListId);
}

//Call delinkRecords method that takes paramInstance instance as parameter.
APIResponse < ActionHandler > response = relatedRecordsOperations.delinkRecords(paramInstance);
Copiedpackage com.zoho.crm.api.sample.restapi.relatedrecords;
import javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpDelete;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.conn.ssl.NoopHostnameVerifier;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;
public class DelinkRelatedRecords 
{
	private static void delinkRelatedRecords()
	{
		try
		{
			HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
			SSLContext sslContext = SSLContext.getDefault();
			SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
			CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
			URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2.1/Products/34770617606020/Price_Books");
			uriBuilder.addParameter("ids", "34770617596026,34770617246019");
			HttpUriRequest requestObj = new HttpDelete(uriBuilder.build());
			requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
			HttpResponse response = httpclient.execute(requestObj);
			HttpEntity responseEntity = response.getEntity();
			System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
			if(responseEntity != null)
			{
				Object responseObject = EntityUtils.toString(responseEntity);
				String responseString = responseObject.toString();
				System.out.println(responseString);
			}
		}
		catch(Exception ex)
		{
			ex.printStackTrace();
		}
	}
	private static void delinkRelatedRecord()
	{
		try
		{
			HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
			SSLContext sslContext = SSLContext.getDefault();
			SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
			CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
			URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2.1/Products/34770617606020/Price_Books/34770610345002");
			HttpUriRequest requestObj = new HttpDelete(uriBuilder.build());
			requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
			HttpResponse response = httpclient.execute(requestObj);
			HttpEntity responseEntity = response.getEntity();
			System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
			if(responseEntity != null)
			{
				Object responseObject = EntityUtils.toString(responseEntity);
				String responseString = responseObject.toString();
				System.out.println(responseString);
			}
		}
		catch(Exception ex)
		{
			ex.printStackTrace();
		}
	}
	public static void main(String[] args) 
	{
		delinkRelatedRecords();
		delinkRelatedRecord();
	}
}
4.0.04.x
Copied//Get instance of RelatedRecordsOperations Class that takes moduleAPIName, recordId and relatedListAPIName as parameter
$relatedRecordsOperations = new RelatedRecordsOperations($relatedListAPIName,  $recordId,  $moduleAPIName);
//Get instance of ParameterMap Class
$paramInstance = new ParameterMap();
foreach($relatedListIds as $relatedListId)
{
  $paramInstance->add(DelinkRecordsParam::ids(), $relatedListId);
}
//Call delinkRecords method that takes paramInstance instance as parameter.
$response = $relatedRecordsOperations->delinkRecords($paramInstance);



//Get instance of RelatedRecordsOperations Class that takes moduleAPIName, recordId and relatedListAPIName as parameter
$relatedRecordsOperations = new RelatedRecordsOperations($relatedListAPIName,$recordId,$moduleAPIName);
//Call updateRecord method that takes relatedListId as parameter.
$response = $relatedRecordsOperations->delinkRecord($relatedListId);
Copied<?php
class DelinkRelatedRecords{
    
    public function execute(){
        $curl_pointer = curl_init();
        
        $curl_options = array();
        $url = "https://www.zohoapis.com/crm/v2.1/Products/3477061000007606020/Price_Books?";
        $parameters = array();
        $parameters["ids"] = "3477061000007596026,3477061000007246019";
        foreach ($parameters as $key=>$value){
            $url =$url.$key."=".$value."&";
        }
        $curl_options[CURLOPT_URL] = $url;
        $curl_options[CURLOPT_RETURNTRANSFER] = true;
        $curl_options[CURLOPT_HEADER] = 1;
        $curl_options[CURLOPT_CUSTOMREQUEST] = "DELETE";
        $headersArray = array();
        $headersArray[] = "Authorization". ":" . "Zoho-oauthtoken " ."1000.30f3a589XXXXXXXXXXXXXXXXXXX4077.dc5XXXXXXXXXXXXXXXXXXXee9e7c171c";
        $curl_options[CURLOPT_HTTPHEADER]=$headersArray;
        
        curl_setopt_array($curl_pointer, $curl_options);
        
        $result = curl_exec($curl_pointer);
        $responseInfo = curl_getinfo($curl_pointer);
        curl_close($curl_pointer);
        list ($headers, $content) = explode("\r\n\r\n", $result, 2);
        if(strpos($headers," 100 Continue")!==false){
            list( $headers, $content) = explode( "\r\n\r\n", $content , 2);
        }
        $headerArray = (explode("\r\n", $headers, 50));
        $headerMap = array();
        foreach ($headerArray as $key) {
            if (strpos($key, ":") != false) {
                $firstHalf = substr($key, 0, strpos($key, ":"));
                $secondHalf = substr($key, strpos($key, ":") + 1);
                $headerMap[$firstHalf] = trim($secondHalf);
            }
        }
        $jsonResponse = json_decode($content, true);
        if ($jsonResponse == null && $responseInfo['http_code'] != 204) {
            list ($headers, $content) = explode("\r\n\r\n", $content, 2);
            $jsonResponse = json_decode($content, true);
        }
        var_dump($headerMap);
        var_dump($jsonResponse);
        var_dump($responseInfo['http_code']);
        
    }
    
}
(new DelinkRelatedRecords())->execute();
3.0.08.x
Copied//Get instance of RelatedRecordsOperations Class that takes relatedListAPIName, recordId and moduleAPIName as parameter
RelatedRecordsOperations relatedRecordsOperations = new RelatedRecordsOperations(relatedListAPIName, recordId, moduleAPIName);
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
foreach(long relatedListId in relatedListIds)
{
    paramInstance.Add(DelinkRecordsParam.IDS, relatedListId);
}
//Call DelinkRecords method that takes paramInstance instance as parameter.
APIResponse<ActionHandler> response = relatedRecordsOperations.DelinkRecords(paramInstance);
Copiedusing System;
using System.IO;
using System.Net;
namespace Com.Zoho.Crm.API.Sample.RestAPI.RelatedRecords
{
    public class DelinkRelatedRecords
    {
        public static void DelinkListofRelatedRecords()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/Products/3477061606020/Price_Books?ids=34770617596026,34770617246019");
            request.Method = "DELETE";
            request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
            request.KeepAlive = true;
            HttpWebResponse response;
            try
            {
                response = (HttpWebResponse)request.GetResponse();
            }
            catch (WebException e)
            {
                if (e.Response == null) { throw; }
                response = (HttpWebResponse)e.Response;
            }
            HttpWebResponse responseEntity = response;
            Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
            string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
            responseEntity.Close();
            Console.WriteLine(responsestring);
        }
        public static void DelinkRelatedRecord()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/Products/3477061606020/Price_Books/347706145002");
            request.Method = "DELETE";
            request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
            request.KeepAlive = true;
            HttpWebResponse response;
            try
            {
                response = (HttpWebResponse)request.GetResponse();
            }
            catch (WebException e)
            {
                if (e.Response == null) { throw; }
                response = (HttpWebResponse)e.Response;
            }
            HttpWebResponse responseEntity = response;
            Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
            string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
            responseEntity.Close();
            Console.WriteLine(responsestring);
        }
    }
}
3.0.03.x.x
Copied# Get instance of RelatedRecordsOperations Class that takes moduleAPIName, recordId and relatedListAPIName as parameter
related_records_operations = RelatedRecordsOperations(related_list_api_name, record_id, module_api_name)
# Get instance of ParameterMap Class
param_instance = ParameterMap()
for related_list_id in related_list_ids:
    param_instance.add(DelinkRecordsParam.ids, related_list_id)
# Call delink_records method that takes ParameterMap instance as parameter.
response = related_records_operations.delink_records(param_instance)


# Get instance of RelatedRecordsOperations Class that takes moduleAPIName, recordId and relatedListAPIName as parameter
related_records_operations = RelatedRecordsOperations(module_api_name, record_id, related_list_api_name)
# Call delink_record method that takes related_list_id as parameter.
response = related_records_operations.delink_record(related_list_id)
Copieddef delink_related_records():
    import requests

    url = 'https://www.zohoapis.com/crm/v2.1/Products/3409643000000798007/Price_Books'

    headers = {
        'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268',
    }

    parameters = {
        'ids': '3409643000002414001,3409643000002414010'
    }

    response = requests.delete(url=url, headers=headers, params=parameters)

    if response is not None:
        print("HTTP Status Code : " + str(response.status_code))

        print(response.json())


delink_related_records()


def delink_related_record():
    import requests

    url = 'https://www.zohoapis.com/crm/v2.1/Products/3409643000000798007/Price_Books/3409643000002414001'

    headers = {
        'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268',
    }

    response = requests.delete(url=url, headers=headers)

    if response is not None:
        print("HTTP Status Code : " + str(response.status_code))

        print(response.json())

delink_related_record()
1.0.010.x
Copied//Get instance of RelatedRecordsOperations Class that takes moduleAPIName, recordId and relatedListAPIName as parameter
let relatedRecordsOperations = new RelatedRecordsOperations(relatedListAPIName, recordId, moduleAPIName);
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
/* Possible parameters of Delink Records operation */
for(let relatedListId of relatedListIds) {
    await paramInstance.add(DelinkRecordsParam.IDS, relatedListId);
}
//Call delinkRecords method that takes ParameterMap instance as parameter.
let response = await relatedRecordsOperations.delinkRecords(paramInstance);
Copiedasync function deLinkRelatedRecords() {
    const got = require("got");

    let url = 'https://www.zohoapis.com/crm/v2.1/Products/3409643000000798007/Price_Books'

    let headers = {
        Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
    }

    let parameters = {
        'ids': '3409643000002414001,3409643000002414010'
    }

    let requestDetails = {
        method : "DELETE",
        headers : headers,
        searchParams : parameters,
        throwHttpErrors : false
    }
    
    let response = await got(url, requestDetails)
    
    if(response != null) {
        console.log(response.statusCode);
        console.log(response.body);
    }
}
deLinkRelatedRecords()

async function deLinkRelatedRecord() {
    const got = require("got");

    let url = 'https://www.zohoapis.com/crm/v2.1/Products/3409643000000798007/Price_Books/3409643000002414001'

    let headers = {
        Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
    }

    let requestDetails = {
        method : "DELETE",
        headers : headers,
        throwHttpErrors : false
    }
    
    let response = await got(url, requestDetails)
    
    if(response != null) {
        console.log(response.statusCode);
        console.log(response.body);
    }
}
deLinkRelatedRecord()
2.1.0
Copied# Get instance of ParameterMap Class
pm = ParameterMap.new
related_list_ids.each do |related_id|
  pm.add(RelatedRecords::RelatedRecordsOperations::DelinkRecordsParam.ids, related_id)
end
# Get instance of RelatedRecordsOperations Class that takes moduleAPIName, recordId and relatedListAPIName as parameter
rro = RelatedRecords::RelatedRecordsOperations.new(related_list_api_name , record_id, module_api_name)
# Call delink_records method that takes ParameterMap instance as parameter.
response = rro.delink_records(pm)




//Get instance of RelatedRecordsOperations Class that takes moduleAPIName, recordId and relatedListAPIName as parameter
  $relatedRecordsOperations = new RelatedRecordsOperations($relatedListAPIName,$recordId,$moduleAPIName);
//Call updateRecord method that takes relatedListId as parameter.
$response = $relatedRecordsOperations->delinkRecord($relatedListId);
Copiedrequire 'net/http'
require 'json'

class DelinkRelatedRecords

    def execute
        parameters ={}
        parameters["ids"]="3524033000006025001"
        query_string = parameters.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join('&')
        url= "https://www.zohoapis.com/crm/v2.1/Leads/3524033000005495065/Attachments"
        url += '?' + query_string if !query_string.nil? && (query_string.strip != '')
        url = URI(url)
        req = Net::HTTP::Delete.new(url.request_uri)
        http = Net::HTTP.new(url.host, url.port)
        http.use_ssl = true
        headers={}
        headers["Authorization"]="Zoho-oauthtoken 1000.dfa7XXXXXXXXXXXXXXXXXX84f9665840.c176aeXXXXXXXXXXXX13f3d37a84d"
        headers&.each { |key, value| req.add_field(key, value) }
        response=http.request(req)
        status_code = response.code.to_i
        headers = response.each_header.to_h
        print status_code
        print headers
        unless response.body.nil?
            print  response.body
        end
    end
end
DelinkRelatedRecords.new.execute
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v2.1/Campaigns/3652397000000327001/Contacts?ids=3652397000000925128,3652397000000649013"
	type: DELETE
	connection:"crm_oauth_connection"
];
info response;

Possible Errors

  • INVALID_MODULEHTTP 400

    The module name given seems to be invalid
    Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name.

  • INVALID_MODULEHTTP 400

    The given module is not supported in API
    Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name.

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have ZohoCRM.modules.{module_name}.DELETE scope. Create a new client with valid scope. Refer to scope section above.

  • NO_PERMISSIONHTTP 403

    Permission denied to delete records
    Resolution: The user does not have permission to delete related records data. Contact your system administrator.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in Server. Contact support team.

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.

  • AUTHORIZATION_FAILEDHTTP 400

    User does not have sufficient privilege to delete related records data
    Resolution: The user does not have the permission to delete related records data. Contact your system administrator.

  • INVALID_DATAHTTP 400

    the related id given seems to be invalid
    Resolution: You have specified an incorrect related record ID. Please specify a valid record ID. Refer to Get Related Records API to get valid record IDs.

  • UNABLE_TO_PARSE_DATA_TYPEHTTP 400

    either the request body or parameters is in wrong format
    Resolution: The parameter values are in the wrong format. Specify valid record IDs in the correct format. Refer to endpoints section above.

Sample Response

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "3652397000000925128"
            },
            "message": "relation removed",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "id": "3652397000000649013"
            },
            "message": "relation removed",
            "status": "success"
        }
    ]
}