Request Details

Request URL

{api-domain}/crm/{version}/Notes/{note_id}

To delete multiple notes:
{api-domain}/crm/{version}/Notes?ids={Entity_ID1, Entity_ID2, Entity_ID3,..}

To delete notes of a specific record:
{api-domain}/crm/{version}/{module_api_name}/{record_id}/Notes/{note_id}

Supported modules

Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, and Custom

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

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

Possible module names

leads, accounts, contacts, deals, campaigns, tasks, events, calls, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, and custom

Possible operation types

ALL - Full access to notes
WRITE - Edit note data
DELETE - Delete note data

Parameters

  • idsstring, mandatory when deleting multiple notes

    Specify the unique IDs of the notes to be deleted.

Note

You can delete a maximum of 100 notes per API call.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v2.1/Notes?ids=2883756000000268003,2883756000000987654,2883756000000736435"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X DELETE
3.0.08.0
CopiedArrayList<Long> notesId = new ArrayList<Long>(Arrays.asList(3477061000006153001L,3477061000006153002L,3477061000006154005L));

//Get instance of NotesOperations Class
NotesOperations notesOperations = new NotesOperations();

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

for (Long id: notesId) {
    paramInstance.add(DeleteNotesParam.IDS, id);
}

//Call deleteNotes method that takes paramInstance as parameter 
APIResponse < ActionHandler > response = notesOperations.deleteNotes(paramInstance);
Copiedpackage com.zoho.crm.api.sample.restapi.notes;
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 DeleteNotes 
{
	private static void deleteNotes()
	{
		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/Notes");
			uriBuilder.addParameter("ids", "34770617772009,34770617769003");
			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 deleteNote()
	{
		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/Notes/34770617772010");
			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 deleteNotesofASpecificRecord()
	{
		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/Leads/34770617736020/Notes/34770617769002");
			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) 
	{
		deleteNotes();
		deleteNote();
		deleteNotesofASpecificRecord();
	}
}
4.0.04.x
Copied//Get instance of NotesOperations Class
$notesOperations = new NotesOperations();
//Get instance of ParameterMap Class
$paramInstance = new ParameterMap();
foreach($notesID as $id)
{
  $paramInstance->add(DeleteNotesParam::ids(), $id);
}
//Call deleteNotes method that takes paramInstance as parameter
$response = $notesOperations->deleteNotes($paramInstance);


//Get instance of NotesOperations Class
$notesOperations = new NotesOperations();
//Call deleteNotes method that takes BodyWrapper instance as parameter
$response = $notesOperations->deleteNote($noteID);
Copied<?php

class DeleteNotes
{
    public function execute(){
        $curl_pointer = curl_init();
        
        $curl_options = array();
        $url = "https://www.zohoapis.com/crm/v2.1/Notes/3524033000006014002";
        
        $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 DeleteNotes())->execute();
Copieddef delete_note(self):
        try:
            record = ZCRMRecord.get_instance('Leads', 3719520000000326007)
            note_ins = ZCRMNote.get_instance(record, 3719520000000512001)
            resp = record.delete_note(note_ins)
            print(resp.status_code)
            print(resp.code)
            print(resp.details)
            print(resp.message)
            print(resp.status)
        except ZCRMException as ex:
            print(ex.status_code)
            print(ex.error_message)
            print(ex.error_code)
            print(ex.error_details)
            print(ex.error_content)
3.0.08.x
Copied//Get instance of NotesOperations Class
NotesOperations notesOperations = new NotesOperations();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
foreach(long id in notesId)
{
    paramInstance.Add(DeleteNotesParam.IDS, id);
}
//Call DeleteNotes method that takes paramInstance as parameter 
APIResponse<ActionHandler> response = notesOperations.DeleteNotes(paramInstance);
Copiedusing System;

using System.IO;

using System.Net;

namespace Com.Zoho.Crm.API.Sample.RestAPI.Notes
{
    public class DeleteNotes
    {
        public static void DeleteListNote()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/Notes?ids=34770617008004,34770617008005");

            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 DeleteNote()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/Notes/3477061008005");

            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 DeleteNotesofASpecificRecord()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/Leads/347706736020/Notes/3477067769002");

            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 NotesOperations Class
notes_operations = NotesOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
# Add the ids to ParameterMap instance
for note_id in note_ids:
    param_instance.add(DeleteNotesParam.ids, note_id)
# Call delete_notes method that takes param_instance as parameter
response = notes_operations.delete_notes(param_instance)


# Get instance of NotesOperations Class
notes_operations = NotesOperations()
# Call delete_note method that takes note_id as parameter
response = notes_operations.delete_note(note_id)
Copieddef delete_notes():
    import requests

    url = 'https://www.zohoapis.com/crm/v2.1/Notes'

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

    parameters = {
        'ids': '3409643000003278008,3409643000003278021'
    }

    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())

delete_notes()


def delete_note():
    import requests

    url = 'https://www.zohoapis.com/crm/v2.1/Notes/3409643000003278008'

    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())

delete_note()
1.0.010.x
Copied//Get instance of NotesOperations Class
let notesOperations = new NotesOperations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
//Add the ids to ParameterMap instance'
for(let noteId of noteIds) {
    await paramInstance.add(DeleteNotesParam.IDS, noteId);
}
//Call deleteNotes method that takes paramInstance as parameter
let response = await notesOperations.deleteNotes(paramInstance);
Copiedasync function deleteNotes() {
    const got = require("got");

    let url = 'https://www.zohoapis.com/crm/v2.1/Notes'

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

    let parameters = {
        ids : '3409643000003278008, 3409643000003278021'
    }

    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);
    } 
}
deleteNotes()

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

    let url = 'https://www.zohoapis.com/crm/v2.1/Notes/3409643000003278008'

    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);
    } 
}

deleteNote()

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

    let url = 'https://www.zohoapis.com/crm/v2.1/Leads/3409643000002267003/Notes'

    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);
    }
}

deleteNotesOfSpecificRecord()
2.1.0
Copied# Get instance of NotesOperations Class
no = Notes::NotesOperations.new
# Get instance of ParameterMap Class
pm = ParameterMap.new
# Add the ids to ParameterMap instance
notes_id.each do |note_id|
  pm.add(Notes::NotesOperations::DeleteNotesParam.ids, note_id)
end
# Call delete_notes method that takes param_instance as parameter
response = no.delete_notes(pm)



# Get instance of NotesOperations Class
no = Notes::NotesOperations.new
# Call delete_note method that takes note_id as parameter
response = no.delete_note(note_id)
Copiedrequire 'net/http'
require 'json'

class DeleteNotes
    def execute
        url ="https://www.zohoapis.com/crm/v2.1/Notes/3524033000006014002"
        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

DeleteNotes.new.execute
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v2.1/Notes?ids=2883756000000268003,2883756000000987654,2883756000000736435"
	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.notes.DELETE scope. Create a new client with valid scope. Refer to scope section above.

  • NO_PERMISSIONHTTP 403

    Permission denied to delete notes details
    Resolution: The user does not have permission to delete notes 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 notes
    Resolution: The user does not have the permission to delete notes data. Contact your system administrator.

  • INVALID_DATAHTTP 400

    record not deleted
    Resolution: The note ID specified in the URL is invalid. Refer to Get Notes API to get valid note 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.

  • REQUIRED_PARAM_MISSINGHTTP 400

    One of the expected parameter is missing
    Resolution: 'ids' parameter is missing in the request. Please specify the IDs of the notes to be deleted. Refer to Get Notes Data API to get valid record IDs.

Sample Response

Copied{
    "data": [
       {
            "code": "SUCCESS",
            "details": {
                "id": "2883756000000308033"
            },
            "message": "record deleted",
            "status": "success"
        },
       {
            "code": "SUCCESS",
            "details": {
                "id": "2883756000000308027"
            },
            "message": "record deleted",
            "status": "success"
        },
       {
            "code": "SUCCESS",
            "details": {
                "id": "2883756000000308021"
            },
            "message": "record deleted",
            "status": "success"
        }
    ]
}