Notes APIs
Notes are to provide some additional information about a contact, account, deal or task. You can find the notes section in most of the modules. Hence, with Notes API, you can create, delete, or update notes. You can perform actions on single or multiple notes.
Get Notes
Purpose
To get the list of notes.
Request Details
Request URL
https://www.zohoapis.com/crm/v2/Notes
To get a specific note:
https://www.zohoapis.com/crm/v2/Notes/{note_id}
To get notes from a specific record:
https://www.zohoapis.com/crm/v2/{module_api_name}/{record_id}/Notes
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
READ - Get note data
Parameters
- pagenumber, optional
To get the list of records from the respective pages. Default value is 1.
- per_pagenumber, optional
To get the list of records available per page. The default and the maximum possible value is 200.
- fieldsstring, optional
Specify the API names of the fields whose details you want to receive in the response.
- sort_orderstring, optional
To sort the list of records in either ascending or descending order.
Possible values: asc - ascending order; desc - descending order
- sort_bystring, optional
Specify the API name of the field based on which the records must be sorted.
Possible values: Field API names. Example: Note_Title
The page and per_page parameter is used to fetch records according to their position in the CRM. Let's assume that the user has to fetch 400 records. The maximum number of records that one can get for an API call is 200. So, for records above the 200th position, they cannot be fetched. By using the page (1, 2) and per_page (200) parameter, the user can fetch all 400 records using 2 API calls.
The sort_order parameter applies to given sort_by parameter value.
If sort_by field is not provided, then it applies to the system-defined field.
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v2/Notes"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copied//Get instance of NotesOperations Class
NotesOperations notesOperations = new NotesOperations();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
paramInstance.add(GetNotesParam.PAGE, 1);
//paramInstance.add(GetNotesParam.PER_PAGE,1);
//Get instance of HeaderMap Class
HeaderMap headerInstance = new HeaderMap();
OffsetDateTime startdatetime = OffsetDateTime.of(2019, 06, 01, 10, 00, 01, 00, ZoneOffset.of("+05:30"));
headerInstance.add(GetNotesHeader.IF_MODIFIED_SINCE, startdatetime);
//Call getNotes method that takes paramInstance and headerInstance as parameters
APIResponse < ResponseHandler > response = notesOperations.getNotes(paramInstance, headerInstance);
Copiedimport javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpGet;
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 NotesAPIs
{
private static void getNotes()
{
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/Notes");
uriBuilder.addParameter("page", "1");
uriBuilder.addParameter("per_page", "4");
uriBuilder.addParameter("fields", "Created_Time,Parent_Id");
HttpUriRequest requestObj = new HttpGet(uriBuilder.build());
requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
requestObj.addHeader("If-Modified-Since", "2019-10-12T17:59:50+05:30");
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 getNote()
{
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/Notes/34770617697022");
uriBuilder.addParameter("fields", "Created_Time,Parent_Id");
HttpUriRequest requestObj = new HttpGet(uriBuilder.build());
requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
requestObj.addHeader("If-Modified-Since", "2019-10-12T17:59:50+05:30");
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 getNotesfromASpecificRecord()
{
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/Leads/34770617736020/Notes");
uriBuilder.addParameter("fields", "Created_Time,Parent_Id");
uriBuilder.addParameter("page", "1");
uriBuilder.addParameter("per_page", "1");
HttpUriRequest requestObj = new HttpGet(uriBuilder.build());
requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
requestObj.addHeader("If-Modified-Since", "2020-10-12T17:59:50+05:30");
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)
{
getNotes();
getNote();
getNotesfromASpecificRecord();
}
}
Copied//Get instance of NotesOperations Class
$notesOperations = new NotesOperations();
//Get instance of ParameterMap Class
$paramInstance = new ParameterMap();
$paramInstance->add(GetNotesParam::page(), 1);
//$paramInstance->add(GetNotesParam::perPage(), 1);
//Get instance of HeaderMap Class
$headerInstance = new HeaderMap();
$headerInstance->add(GetNotesHeader::IfModifiedSince(), date_create("2019-05-07T15:32:24")->setTimezone(new \DateTimeZone(date_default_timezone_get())));
//Call getNotes method that takes paramInstance and headerInstance as parameters
$response = $notesOperations->getNotes($paramInstance, $headerInstance);
Copied<?php
class GetNotes{
public function execute(){
$curl_pointer = curl_init();
$curl_options = array();
$url = "https://www.zohoapis.com/crm/v2/Notes?";
$parameters = array();
$parameters["page"]="1";
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] = "GET";
$headersArray = array();
$headersArray[] = "Authorization". ":" . "Zoho-oauthtoken " ."1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf";
$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 GetNotes())->execute();
Copied//Get instance of NotesOperations Class
NotesOperations notesOperations = new NotesOperations();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
paramInstance.Add(GetNotesParam.PAGE, 1);
//paramInstance.Add(GetNotesParam.PER_PAGE, 1);
paramInstance.Add(GetNotesParam.FIELDS, "Note_Title,Note_Content");
//Get instance of HeaderMap Class
HeaderMap headerInstance = new HeaderMap();
DateTimeOffset ifModifiedSince = new DateTimeOffset(new DateTime(2020, 05, 15, 12, 0, 0, DateTimeKind.Local));
headerInstance.Add(GetNotesHeader.IF_MODIFIED_SINCE, ifModifiedSince);
//Call GetNotes method that takes paramInstance and headerInstance as parameters
APIResponse<ResponseHandler> response = notesOperations.GetNotes(paramInstance, headerInstance);
Copiedusing System;
using System.IO;
using System.Net;
using System.Xml;
using Newtonsoft.Json;
namespace Com.Zoho.Crm.API.Sample.RestAPI.Notifications
{
public class NotificationDetails
{
public static void GetNotificationDetails()
{
HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2/actions/watch?channel_id=100068001&module=Contacts");
request.Method = "GET";
request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
string IfModifiedSince = JsonConvert.SerializeObject("2020-05-15T12:00:00+05:30");
IfModifiedSince = IfModifiedSince.Replace("\\", "");
IfModifiedSince = IfModifiedSince.Replace("\"", "");
DateTime dateConversion = XmlConvert.ToDateTime(IfModifiedSince, XmlDateTimeSerializationMode.Utc);
request.IfModifiedSince = dateConversion;
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);
}
}
}
Copied# Get instance of NotesOperations Class
notes_operations = NotesOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
# Possible parameters for Get Notes
param_instance.add(GetNotesParam.page, 1)
param_instance.add(GetNotesParam.per_page, 200)
# Get instance of HeaderMap Class
header_instance = HeaderMap()
header_instance.add(GetNotesHeader.if_modified_since, datetime.fromisoformat('2019-06-01T00:00:00+05:30'))
# Call get_notes method that takes paramInstance and headerInstance as parameters
response = notes_operations.get_notes(param_instance, header_instance)
# Get instance of NotesOperations Class
notes_operations = NotesOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
# Possible parameters of Get Note Operation
param_instance.add(GetNoteParam.fields, "id,Note_Content")
# Get instance of HeaderMap Class
header_instance = HeaderMap()
# Possible headers of Get Note Operation
header_instance.add(GetNoteHeader.if_modified_since, datetime(2020, 6, 6, 10, 11, 12))
# Call get_note method that takes note_id, ParameterMap instance, HeaderMap instance as parameter
response = notes_operations.get_note(note_id, param_instance, header_instance)
Copieddef get_notes():
import requests
url = 'https://www.zohoapis.com/crm/v2/Notes'
headers = {
'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268',
'If-Modified-Since': '2020-03-19T17:59:50+05:30'
}
parameters = {
'page': 1,
'per_page': 30,
'fields': 'Created_Time,Parent_Id'
}
response = requests.get(url=url, headers=headers, params=parameters)
if response is not None:
print("HTTP Status Code : " + str(response.status_code))
print(response.json())
get_notes()
def get_note():
import requests
url = 'https://www.zohoapis.com/crm/v2/Notes/3409643000003278008'
headers = {
'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268',
'If-Modified-Since': '2020-03-19T17:59:50+05:30'
}
parameters = {
'fields': 'id,Parent_Id'
}
response = requests.get(url=url, headers=headers, params=parameters)
if response is not None:
print("HTTP Status Code : " + str(response.status_code))
print(response.json())
get_note()
def get_notes_of_a_specific_record():
import requests
url = 'https://www.zohoapis.com/crm/v2/Leads/3409643000002267003/Notes'
headers = {
'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268',
'If-Modified-Since': '2020-03-19T17:59:50+05:30'
}
parameters = {
'page': 1,
'per_page': 2,
'fields': 'Created_Time,Parent_Id'
}
response = requests.get(url=url, headers=headers, params=parameters)
if response is not None:
print("HTTP Status Code : " + str(response.status_code))
print(response.json())
get_notes_of_a_specific_record()
Copied//Get instance of NotesOperations Class
let notesOperations = new NotesOperations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
/* Possible parameters for Get Notes */
await paramInstance.add(GetNotesParam.PAGE, 1);
await paramInstance.add(GetNotesParam.PER_PAGE, 200);
await paramInstance.add(GetNotesParam.FIELDS, "id,Modified_Time");
//Get instance of HeaderMap Class
let headerInstance = new HeaderMap();
/* Possible headers for Get Notes */
await headerInstance.add(GetNotesHeader.IF_MODIFIED_SINCE, new Date("2019-06-01T00:00:00+05:30"));
//Call getNotes method that takes paramInstance and headerInstance as parameters
let response = await notesOperations.getNotes(paramInstance, headerInstance);
Copiedasync function getNotes() {
const got = require("got");
let url = 'https://www.zohoapis.com/crm/v2/Notes'
let headers = {
Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf",
'If-Modified-Since' : '2020-03-19T17:59:50+05:30'
}
let parameters = {
fields : 'Created_Time,Parent_Id',
page : 1,
per_page : 30
}
let requestDetails = {
method : "GET",
headers : headers,
searchParams : parameters,
throwHttpErrors : false
}
let response = await got(url, requestDetails)
if(response != null) {
console.log(response.statusCode);
console.log(response.body);
}
}
getNotes()
async function getNote() {
const got = require("got");
let url = 'https://www.zohoapis.com/crm/v2/Notes/3409643000003278008'
let headers = {
Authorization : "Zoho-oauthtoken 1000.354df3680b39983084e6a9d1894732f3.aae0efe21a1cf8c14beb10f6f4c92bc9",
'If-Modified-Since' : '2020-03-19T17:59:50+05:30'
}
let parameters = {
fields : 'id,Parent_Id'
}
let requestDetails = {
method : "GET",
headers : headers,
searchParams : parameters,
throwHttpErrors : false
}
let response = await got(url, requestDetails)
if(response != null) {
console.log(response.statusCode);
console.log(response.body);
}
}
getNote()
async function getNotesOfaSpecificRecord() {
const got = require("got");
let url = 'https://www.zohoapis.com/crm/v2/Leads/3409643000002267003/Notes'
let headers = {
Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf",
'If-Modified-Since' : '2020-03-19T17:59:50+05:30'
}
let parameters = {
fields : 'Created_Time,Parent_Id',
page : 1,
per_page : 20
}
let requestDetails = {
method : "GET",
headers : headers,
searchParams : parameters,
throwHttpErrors : false
}
let response = await got(url, requestDetails)
if(response != null) {
console.log(response.statusCode);
console.log(response.body);
}
}
getNotesOfaSpecificRecord()
Copied# Get instance of NotesOperations Class
no = Notes::NotesOperations.new
# Get instance of ParameterMap Class
pm = ParameterMap.new
# pm.add(Notes::NotesOperations::GetNotesParam.page,"1")
# Get instance of HeaderMap Class
hm = HeaderMap.new
# hm.add(Notes::NotesOperations::GetNotesHeader.If_modified_since,"2020-08-05T13:36:16+05:30")
# Call get_notes method that takes paramInstance and headerInstance as parameters
response = no.get_notes(pm, hm)
Copiedclass GetNotes
def execute
parameters ={}
parameters["page"]="1"
query_string = parameters.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join('&')
url= "https://www.zohoapis.com/crm/v2/Notes"
url += '?' + query_string if !query_string.nil? && (query_string.strip != '')
url = URI(url)
req = Net::HTTP::Get.new(url.request_uri)
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
headers={}
headers["Authorization"]="Zoho-oauthtoken 1000.50XXXXXXXXX&77e3a.44XXXXXXXXX8353"
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
GetNotes.new.execute
Copied//Get instance of NotesOperations Class
let notesOperations = new ZCRM.Note.Operations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
/* Possible parameters for Get Notes */
await paramInstance.add(ZCRM.Note.Model.GetNotesParam.PAGE, 1);
await paramInstance.add(ZCRM.Note.Model.GetNotesParam.PER_PAGE, 200);
// await paramInstance.add(ZCRM.Note.Model.GetNotesParam.FIELDS, "id,Modified_Time");
//Get instance of HeaderMap Class
let headerInstance = new HeaderMap();
/* Possible headers for Get Notes */
await headerInstance.add(ZCRM.Note.Model.GetNotesHeader.IF_MODIFIED_SINCE, new Date("2019-06-01T00:00:00+05:30"));
//Call getNotes method that takes paramInstance and headerInstance as parameters
let response = await notesOperations.getNotes(paramInstance, headerInstance);
Copiedvar listener = 0;
class NotesAPIs {
async getNotes() {
var url = "https://www.zohoapis.com/crm/v2/Notes"
var parameters = new Map()
var headers = new Map()
var token = {
clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
redirectUrl:"http://127.0.0.1:5500/redirect.html",
scope:"ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
}
var accesstoken = await new NotesAPIs().getToken(token)
headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
headers.set("If-Modified-Since", "2019-10-12T17:59:50+05:30")
parameters.set("page", "1")
parameters.set("per_page", "4")
parameters.set("fields", "Created_Time,Parent_Id")
var requestMethod = "GET"
var reqBody = null
var params = "";
parameters.forEach(function(value, key) {
if (parameters.has(key)) {
if (params) {
params = params + key + '=' + value + '&';
}
else {
params = key + '=' + value + '&';
}
}
});
var apiHeaders = {};
if(headers) {
headers.forEach(function(value, key) {
apiHeaders[key] = value;
});
}
if (params.length > 0){
url = url + '?' + params.substring(0, params.length - 1);
}
var requestObj = {
uri : url,
method : requestMethod,
headers : apiHeaders,
body : JSON.stringify(reqBody),
encoding: "utf8",
allowGetBody : true,
throwHttpErrors : false
};
var result = await new NotesAPIs().makeAPICall(requestObj);
console.log(result.status)
console.log(result.response)
}
async getNote() {
var url = "https://www.zohoapis.com/crm/v2/Notes/35240336250001"
var parameters = new Map()
var headers = new Map()
var token = {
clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
redirectUrl:"http://127.0.0.1:5500/redirect.html",
scope:"ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
}
var accesstoken = await new NotesAPIs().getToken(token)
headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
headers.set("If-Modified-Since", "2019-10-12T17:59:50+05:30")
parameters.set("fields", "Created_Time,Parent_Id")
var requestMethod = "GET"
var reqBody = null
var params = "";
parameters.forEach(function(value, key) {
if (parameters.has(key)) {
if (params) {
params = params + key + '=' + value + '&';
}
else {
params = key + '=' + value + '&';
}
}
});
var apiHeaders = {};
if(headers) {
headers.forEach(function(value, key) {
apiHeaders[key] = value;
});
}
if (params.length > 0){
url = url + '?' + params.substring(0, params.length - 1);
}
var requestObj = {
uri : url,
method : requestMethod,
headers : apiHeaders,
body : JSON.stringify(reqBody),
encoding: "utf8",
allowGetBody : true,
throwHttpErrors : false
};
var result = await new NotesAPIs().makeAPICall(requestObj);
console.log(result.status)
console.log(result.response)
}
async getNotesfromASpecificRecord() {
var url = "https://www.zohoapis.com/crm/v2/Leads/34770617736020/Notes"
var parameters = new Map()
var headers = new Map()
var token = {
clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
redirectUrl:"http://127.0.0.1:5500/redirect.html",
scope:"ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
}
var accesstoken = await new NotesAPIs().getToken(token)
headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
headers.set("If-Modified-Since", "2020-10-12T17:59:50+05:30")
parameters.set("fields", "Created_Time,Parent_Id")
parameters.set("page", "1")
parameters.set("per_page", "1")
var requestMethod = "GET"
var reqBody = null
var params = "";
parameters.forEach(function(value, key) {
if (parameters.has(key)) {
if (params) {
params = params + key + '=' + value + '&';
}
else {
params = key + '=' + value + '&';
}
}
});
var apiHeaders = {};
if(headers) {
headers.forEach(function(value, key) {
apiHeaders[key] = value;
});
}
if (params.length > 0){
url = url + '?' + params.substring(0, params.length - 1);
}
var requestObj = {
uri : url,
method : requestMethod,
headers : apiHeaders,
body : JSON.stringify(reqBody),
encoding: "utf8",
allowGetBody : true,
throwHttpErrors : false
};
var result = await new NotesAPIs().makeAPICall(requestObj);
console.log(result.status)
console.log(result.response)
}
async getToken(token) {
if(listener == 0) {
window.addEventListener("storage", function(reponse) {
if(reponse.key === "access_token" && (reponse.oldValue != reponse.newValue || reponse.oldValue == null)){
location.reload();
}
if(reponse.key === "access_token"){
sessionStorage.removeItem("__auth_process");
}
}, false);
listener = 1;
if(sessionStorage.getItem("__auth_process")) {
sessionStorage.removeItem("__auth_process");
}
}
["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
var isKeyExists = localStorage.hasOwnProperty(k);
if(isKeyExists) {
sessionStorage.setItem(k, localStorage[k]);
}
localStorage.removeItem(k);
});
var valueInStore = sessionStorage.getItem("access_token");
var tokenInit = sessionStorage.getItem("__token_init");
if(tokenInit != null && valueInStore != null && Date.now() >= parseInt(tokenInit) + 59 * 60 * 1000){ // check after 59th minute
valueInStore = null;
sessionStorage.removeItem("access_token");
}
var auth_process = sessionStorage.getItem("__auth_process");
if ((valueInStore == null && auth_process == null) || (valueInStore == 'undefined' && (auth_process == null || auth_process == "true"))) {
var accountsUrl = "https://accounts.zoho.com/oauth/v2/auth"
var clientId;
var scope;
var redirectUrl;
if(token != null) {
clientId = token.clientId;
scope = token.scope;
redirectUrl = token.redirectUrl;
}
var fullGrant = sessionStorage.getItem("full_grant");
var grantedForSession = sessionStorage.getItem("granted_for_session");
if(sessionStorage.getItem("__token_init") != null && ((fullGrant != null && "true" == full_grant) || (grantedForSession != null && "true" == grantedForSession))) {
accountsUrl += '/refresh';
}
if (clientId && scope) {
sessionStorage.setItem("__token_init", Date.now());
sessionStorage.removeItem("access_token");
sessionStorage.setItem("__auth_process", "true");
window.open(accountsUrl + "?" + "scope" + "=" + scope + "&"+ "client_id" +"=" + clientId + "&response_type=token&state=zohocrmclient&redirect_uri=" + redirectUrl);
["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
var isKeyExists = localStorage.hasOwnProperty(k);
if(isKeyExists){
sessionStorage.setItem(k, localStorage[k]);
}
localStorage.removeItem(k);
});
valueInStore = sessionStorage.getItem("access_token");
}
}
if(token != null && valueInStore != 'undefined'){
token.accessToken = valueInStore;
}
return token.accessToken;
}
async makeAPICall(requestDetails) {
return new Promise(function (resolve, reject) {
var body, xhr, i;
body = requestDetails.body || null;
xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.open(requestDetails.method, requestDetails.uri, true);
for (i in requestDetails.headers) {
xhr.setRequestHeader(i, requestDetails.headers[i]);
}
xhr.send(body);
xhr.onreadystatechange = function() {
if(xhr.readyState == 4) {
resolve(xhr);
}
}
})
}
}
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v2/Notes"
type: GET
connection:"crm_oauth_connection"
];
info response;
Response JSON Keys
- OwnerJSON object
Represents the name, ID, and email of the record owner.
- Modified_Timestring
Represents the date and time at which the current note was last modified.
- $attachmentsJSON array
Represents the details of the attachment, if the current note has any.
- Created_Timestring
Represents the date and time at which the note was created.
- Parent_Idstring
Represents the display name and the unique ID of the parent record.
- $editableboolean
Represents if the user can edit the current note.
true: The user can edit the current note.
false: The user cannot edit the current note. - $se_modulestring
Represents the API name of the parent module of the note.
- Modified_ByJSON object
Represents the name, ID, and email of the user who last modified the note.
- idstring
Represents the unique ID of the current note.
- Created_ByJSON object
Represents the name, ID, and email of the user who created the current note.
- Note_Titlestring
Represents the title of the current note.
- Note_Contentstring
Represents the content of the current note.
- $is_shared_to_clientboolean
Represents if the note is shared with a client portal user.
- sizeinteger
Represents the size of the voice note in bytes, if any.
- $voice_noteboolean
Represents if the current note has a voice note attached.
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.READ scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to read notes details
Resolution: The user does not have permission to retrieve 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 read notes
Resolution: The user does not have the permission to retrieve notes data. Contact your system administrator.
Sample Response
Copied{
"data": [
{
"Owner": {
"name": "Patricia Boyle",
"id": "4150868000000225013",
"email": "patricia.b@zohocorp.com"
},
"Modified_Time": "2020-07-28T11:58:59+05:30",
"$attachments": null,
"Created_Time": "2020-07-28T11:55:47+05:30",
"Parent_Id": {
"name": null,
"id": "4150868000002567076"
},
"$editable": true,
"$se_module": "Leads",
"$is_shared_to_client": false,
"Modified_By": {
"name": "Patricia Boyle",
"id": "4150868000000225013",
"email": "patricia.b@zohocorp.com"
},
"$size": null,
"$state": "save",
"$voice_note": false,
"id": "4150868000002748029",
"Created_By": {
"name": "Patricia Boyle",
"id": "4150868000000225013",
"email": "patricia.b@zohocorp.com"
},
"Note_Title": "Contacted",
"Note_Content": null
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}
}