Disable Notifications
Purpose
To stop all the instant notifications enabled by the user for a channel.
Endpoints
Request Details
Request URL
https://www.zohoapis.com/crm/v2/actions/watch
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.notifications.{operations_type}
Possible operation types
ALL - Full access to notification data
DELETE - Delete notification details
Sample Request
Copiedhttps://www.zohoapis.com/crm/v2/actions/watch?channel_ids=1000000068003,1000000068001,1000000068002"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X DELETE
3.0.08.0
CopiedArrayList<Long> channelIds = new ArrayList<Long>(Arrays.asList(3477061000005208001l));
//Get instance of NotificationOperations Class
NotificationOperations notificationOperations = new NotificationOperations();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
for (Long id: channelIds) {
paramInstance.add(DisableNotificationsParam.CHANNEL_IDS, id);
}
//Call disableNotifications method that takes paramInstance as parameter
APIResponse < ActionHandler > response = notificationOperations.disableNotifications(paramInstance);
Copiedimport 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 DisableNotifications
{
public static void main(String[] args)
{
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/actions/watch");
uriBuilder.addParameter("channel_ids", "10068001");
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();
}
}
}
3.0.07.x
Copied//Get instance of NotificationOperations Class
$notificationOperations = new NotificationOperations();
//Get instance of ParameterMap Class
$paramInstance = new ParameterMap();
foreach($channelIds as $id)
{
$paramInstance->add(DisableNotificationsParam::channelIds(), $id);
}
//Call disableNotifications method that takes paramInstance as parameter
$response = $notificationOperations->disableNotifications($paramInstance);
Copied<?php
class DisableNotifications
{
public function execute(){
$curl_pointer = curl_init();
$curl_options = array();
$url ="https://www.zohoapis.com/crm/v2/actions/watch?";
$parameters = array();
$parameters["channel_ids"]="10068001";
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.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 DisableNotifications())->execute();
3.0.08.x
Copied//Get instance of NotificationOperations Class
NotificationOperations notificationOperations = new NotificationOperations();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
foreach (long id in channelIds)
{
paramInstance.Add(DisableNotificationsParam.CHANNEL_IDS, id);
}
//Call disableNotifications method that takes paramInstance as parameter
APIResponse<ActionHandler> response = notificationOperations.DisableNotifications(paramInstance);
Copiedusing System;
using System.IO;
using System.Net;
namespace Com.Zoho.Crm.API.Sample.RestAPI.Notifications
{
public class DisableNotifications
{
public static void DisableNotification()
{
HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2/actions/watch?channel_ids=1000000068001");
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 NotificationOperations Class
notification_operations = NotificationOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
for channel_id in channel_ids:
param_instance.add(DisableNotificationsParam.channel_ids, channel_id)
# Call disable_notifications method that takes paramInstance as parameter
response = notification_operations.disable_notifications(param_instance)
Copieddef disable_notifications():
import requests
url = 'https://www.zohoapis.com/crm/v2/actions/watch'
headers = {
'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268'
}
parameters = {
'channel_ids': '1000000068001'
}
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())
disable_notifications()
1.0.010.x
Copied//Get instance of NotificationOperations Class
let notificationOperations = new NotificationOperations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
//Possible parameters for disable Notifications operation
for(let channelId of channelIds) {
await paramInstance.add(DisableNotificationsParam.CHANNEL_IDS, channelId);
}
//Call disableNotifications method that takes paramInstance as parameter
let response = await notificationOperations.disableNotifications(paramInstance);
Copiedasync function disableNotifications() {
const got = require("got");
let url = 'https://www.zohoapis.com/crm/v2/actions/watch'
let headers = {
Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}
let parameters = {
'channel_ids': '1000000068001'
}
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);
}
}
disableNotifications()
2.02.x.x
Copied# Get instance of NotificationOperations Class
no = Notification::NotificationOperations.new
# Get instance of ParameterMap Class
pm = ParameterMap.new
channel_ids.each do |channel_id|
pm.add(Notification::NotificationOperations::DisableNotificationsParam.channel_ids, channel_id)
end
# Call disable_notifications method that takes paramInstance as parameter
response = no.disable_notifications(pm)
Copiedclass DisableNotifications
def execute
parameters ={}
parameters["channel_ids"]="1000000068001"
query_string = parameters.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join('&')
url= "https://www.zohoapis.com/crm/v2/actions/watch"
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.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
DisableNotifications.new.execute
1.0.0ES6
Copied//Get instance of NotificationOperations Class
let notificationOperations = new ZCRM.Notification.Operations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
//Possible parameters for disable Notifications operation
for(let channelId of channelIds) {
await paramInstance.add(ZCRM.Notification.Model.DisableNotificationsParam.CHANNEL_IDS, channelId);
}
//Call disableNotifications method that takes paramInstance as parameter
let response = await notificationOperations.disableNotifications(paramInstance);
Copiedvar listener = 0;
class DisableNotifications {
async disableNotification() {
var url = "https://www.zohoapis.com/crm/v2/actions/watch"
var parameters = new Map()
var headers = new Map()
var token = {
clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
redirectUrl:"http://127.0.0.1:5500/redirect.html",
scope:"ZohoCRM.notifications.ALL,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 DisableNotifications().getToken(token)
headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
parameters.set("channel_ids", "1068001")
var requestMethod = "DELETE"
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 DisableNotifications().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);
}
}
})
}
}
Parameters
- channel_idsInteger, mandatory
Specify the unique IDs of the notification channels to be disabled, separated by commas.
Possible values: Channel IDs separated by commas.
For example: 1000000068003,1000000068001.
Sample Response
Copied{
"watch": [
{
"code": "SUCCESS",
"details": {
"resource_uri": "https://www.zohoapis.com/crm/v2/Cases",
"resource_id": "1000000000089",
"channel_id": "1000000068003"
},
"message": "Successfully un-subscribed from actions-watch",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"resource_uri": "https://www.zohoapis.com/crm/v2/Solutions",
"resource_id": "1000000000091",
"channel_id": "1000000068001"
},
"message": "Successfully un-subscribed from actions-watch",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"resource_uri": "https://www.zohoapis.com/crm/v2/Contacts",
"resource_id": "1000000000045",
"channel_id": "1000000068001"
},
"message": "Successfully un-subscribed from actions-watch",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"resource_uri": "https://www.zohoapis.com/crm/v2/Price_Books",
"resource_id": "1000000000097",
"channel_id": "1000000068001"
},
"message": "Successfully un-subscribed from actions-watch",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"resource_uri": "https://www.zohoapis.com/crm/v2/Deals",
"resource_id": "1000000000047",
"channel_id": "1000000068002"
},
"message": "Successfully un-subscribed from actions-watch",
"status": "success"
}
]
}