Disable Specific Notifications

Purpose

To disable notifications for the specified events in a channel.

Request Details

Request URL

https://www.zohoapis.com/crm/v2/actions/watch

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.notifications.{operation_type}

Possible operation types

ALL - Full access to notification data
WRITE - Edit notification details
UPDATE - Update notification details

Sample Request

Copiedhttps://www.zohoapis.com/crm/v2/actions/watch"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X PATCH
-d "@inputData.json"
3.0.08.0
Copied//Get instance of NotificationOperations Class
NotificationOperations notificationOperations = new NotificationOperations();

//Get instance of BodyWrapper Class that will contain the request body
BodyWrapper bodyWrapper = new BodyWrapper();

//List of Notification instances
List < com.zoho.crm.api.notification.Notification > notificationList = new ArrayList < com.zoho.crm.api.notification.Notification > ();

//Get instance of Notification Class
com.zoho.crm.api.notification.Notification notification = new com.zoho.crm.api.notification.Notification();

//Set ChannelId to the Notification instance
notification.setChannelId(100000006800211 l);

List < String > events = new ArrayList < String > ();

events.add("Deals.edit");

//To subscribe based on particular operations on given modules.
notification.setEvents(events);

notification.setDeleteevents(true);

//Add Notification instance to the list
notificationList.add(notification);

//Set the list to notification in BodyWrapper instance
bodyWrapper.setWatch(notificationList);

//Call disableNotification which takes BodyWrapper instance as parameter
APIResponse < ActionHandler > response = notificationOperations.disableNotification(bodyWrapper);
Copiedimport javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
import org.apache.http.client.methods.HttpPatch;
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.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.protocol.HTTP;
import org.apache.http.util.EntityUtils;
import org.json.JSONArray;
import org.json.JSONObject;
public class DisableSpecificNotifications 
{
	@SuppressWarnings("deprecation")
	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");
			HttpUriRequest requestObj = new HttpPatch(uriBuilder.build());
			HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
			JSONObject requestBody = new JSONObject();
			JSONArray recordArray = new JSONArray();
			JSONObject recordObject = new JSONObject();
			recordObject.put("channel_id", "10068002");
			JSONArray events = new JSONArray();
			events.put("Deals.create");
			recordObject.put("events", events);
			recordObject.put("_delete_events", true);
			recordArray.put(recordObject);
			requestBody.put("watch", recordArray);
			requestBase.setEntity(new StringEntity(requestBody.toString(), HTTP.UTF_8));
			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 BodyWrapper Class that will contain the request body
$bodyWrapper = new BodyWrapper();
//List of Notification instances
$notificationList = array();
//Get instance of Notification Class
$notificationClass = 'com\zoho\crm\api\notification\Notification';
$notification = new $notificationClass();
//Set ChannelId to the Notification instance
$notification->setChannelId("10006800211");
$events = array();
array_push($events, "Deals.edit");
//To subscribe based on particular operations on given modules.
$notification->setEvents($events);
$notification->setDeleteevents(true);
//Add Notification instance to the list
array_push($notificationList, $notification);
//Set the list to notification in BodyWrapper instance
$bodyWrapper->setWatch($notificationList);
//Call disableNotification which takes BodyWrapper instance as parameter
$response = $notificationOperations->disableNotification($bodyWrapper);
Copied<?php

class DisableSpecificNotifications
{
    public function execute(){
        $curl_pointer = curl_init();
        
        $curl_options = array();
        $url ="https://www.zohoapis.com/crm/v2/actions/watch";
        
        $curl_options[CURLOPT_URL] =$url;
        $curl_options[CURLOPT_RETURNTRANSFER] = true;
        $curl_options[CURLOPT_HEADER] = 1;
        $curl_options[CURLOPT_CUSTOMREQUEST] = "PATCH";
        $requestBody = array();
        $recordArray = array();
        $recordObject = array();
        $events=array();
        $events[]="Solutions.create";
        $events[]="Price_Books.create";

        $recordObject["channel_id"]="10068001";
        $recordObject["events"] = $events;
        $recordObject["_delete_events"] = true;
        
        $recordArray[] = $recordObject;
        $requestBody["watch"] =$recordArray;
        $curl_options[CURLOPT_POSTFIELDS]= json_encode($requestBody);
        $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 DisableSpecificNotifications())->execute();
3.0.08.x
Copied//Get instance of NotificationOperations Class
NotificationOperations notificationOperations = new NotificationOperations();
//Get instance of BodyWrapper Class that will contain the request body
BodyWrapper bodyWrapper = new BodyWrapper();
//List of Notification instances
List<API.Notification.Notification> notificationList = new List<API.Notification.Notification>();
//Get instance of Notification Class
API.Notification.Notification notification = new API.Notification.Notification();
//Set ChannelId to the Notification instance
notification.ChannelId = 100000006800211;
List<string> events = new List<string>();
events.Add("Deals.edit");
//To subscribe based on particular operations on given modules.
notification.Events = events;
notification.Deleteevents = true;
//Add Notification instance to the list
notificationList.Add(notification);
//Set the list to notification in BodyWrapper instance
bodyWrapper.Watch = notificationList;
//Call disableNotification which takes BodyWrapper instance as parameter
APIResponse<ActionHandler> response = notificationOperations.DisableNotification(bodyWrapper);
Copiedusing System;
using System.IO;
using System.Net;
using System.Text;
using Newtonsoft.Json.Linq;
namespace Com.Zoho.Crm.API.Sample.RestAPI.Notifications
{
    public class DisableSpecificNotifications
    {
        public static void DisableSpecificNotification()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2/actions/watch");
            request.Method = "PATCH";
            request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
            JObject requestBody = new JObject();
            JArray recordArray = new JArray();
            JObject recordObject = new JObject();
            recordObject.Add("channel_id", "1000000068002");
            JArray events = new JArray();
            events.Add("Deals.create");
            recordObject.Add("events", events);
            recordObject.Add("_delete_events", true);
            recordArray.Add(recordObject);
            requestBody.Add("watch", recordArray);
            string dataString = requestBody.ToString();
            var data = Encoding.UTF8.GetBytes(dataString);
            int dataLength = data.Length;
            request.ContentLength = dataLength;
            using (var writer = request.GetRequestStream())
            {
                writer.Write(data, 0, dataLength);
            }
            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 BodyWrapper Class that will contain the request body
body_wrapper = BodyWrapper()
# List to hold Notification instances
notifications = []
# Get instance of Notification Class
notification = Notification()
# Set channel Id of the Notification
notification.set_channel_id(100000006800211)
# To subscribe based on particular operations on given modules.
notification.set_events(['Leads.create'])
notification.set_deleteevents(True)
# Add Notification instance to the list
notifications.append(notification)
# Set the list to notifications in BodyWrapper instance
body_wrapper.set_watch(notifications)
# Call disable_notification which takes BodyWrapper instance as parameter
response = notification_operations.disable_notification(body_wrapper)
Copieddef disable_specific_notifications():
    import requests
    import json

    url = 'https://www.zohoapis.com/crm/v2/actions/watch'

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

    request_body = dict()
    record_list = list()
    events = ['Deals.create']

    record_object = {
        'events': events,
        '_delete_events': True
    }

    record_list.append(record_object)
    request_body['watch'] = record_list

    response = requests.patch(url=url, headers=headers, data=json.dumps(request_body).encode('utf-8'))

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

        print(response.json())

disable_specific_notifications()
1.0.010.x
Copied//Get instance of NotificationOperations Class
let notificationOperations = new NotificationOperations();
//Get instance of BodyWrapper Class that will contain the request body
let bodyWrapper = new BodyWrapper();
//Array of Notification instances
let notificationsArray = [];
//Get instance of Notification Class
let notification = new Notification();
//Set channel Id of the Notification
notification.setChannelId(1000000068002n);
let events = ["Accounts.edit"];
//To subscribe based on particular operations on given modules.
notification.setEvents(events);
notification.setDeleteevents(true);
//Add Notification instance to the array
notificationsArray.push(notification);
//Set the array to notifications in BodyWrapper instance
bodyWrapper.setWatch(notificationsArray);
//Call disableNotification which takes BodyWrapper instance as parameter
let response = await notificationOperations.disableNotification(bodyWrapper);
Copiedasync function disableSpecificNotifications() {
    const got = require("got");

    let url = 'https://www.zohoapis.com/crm/v2/actions/watch'

    let headers = {
        Authorization : "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2"
    }

    let requestBody = {}
    let recordArray = []

    let events = ['Deals.create']

    let recordObject = {
        'events': events,
        '_delete_events': True
    }

    recordArray.push(recordObject)

    requestBody['watch'] = recordArray

    let requestDetails = {
        method : "PATCH",
        headers : headers,
        body : JSON.stringify(requestBody),
        encoding: "utf8",
        throwHttpErrors : false
    };
    
    let response = await got(url, requestDetails)
    
    if(response != null) {
        console.log(response.statusCode);
        console.log(response.body);
    }
}
disableSpecificNotifications()
2.02.x.x
Copied# Get instance of NotificationOperations Class
no = Notification::NotificationOperations.new
# Get instance of BodyWrapper Class that will contain the request body
bw = Notification::BodyWrapper.new
# Get instance of Notification Class
notification = Notification::Notification.new
# Set channel Id of the Notification
notification.channel_id = 10_000_000_680_211
# To subscribe based on particular operations on given modules.
events = ['Deals.edit']
notification.deleteevents = true
notification.events = events
# Add Notification instance to the list
notifications = [notification]
# Set the list to notifications in BodyWrapper instance
bw.watch = notifications
response = no.disable_notification(bw)
Copiedclass DisableSpecificNotifications
    def execute
       
        url ="https://www.zohoapis.com/crm/v2/actions/watch"
        url = URI(url)
        req = Net::HTTP::Patch.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) }
       
        request_body = {};
        record_array = [];
        record_object = {};
        events=["Solutions.create","Price_Books.create"]

        record_object["channel_id"]="1000000068001";
        record_object["_delete_events"]=true

        record_object["events"] = events;
    
        record_array = [record_object];
        request_body["watch"] =record_array; 
        request_json = request_body.to_json
        req.body = request_json.to_s
        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

DisableSpecificNotifications.new.execute
1.0.0ES6
Copied//Get instance of NotificationOperations Class
let notificationOperations = new ZCRM.Notification.Operations();
//Get instance of BodyWrapper Class that will contain the request body
let bodyWrapper = new ZCRM.Notification.Model.BodyWrapper();
//Array of Notification instances
let notificationsArray = [];
//Get instance of Notification Class
let notification = new ZCRM.Notification.Model.Notification();
//Set channel Id of the Notification
notification.setChannelId(168002n);
let events = ["Accounts.edit"];
//To subscribe based on particular operations on given modules.
notification.setEvents(events);
notification.setDeleteevents(true);
//Add Notification instance to the array
notificationsArray.push(notification);
//Set the array to notifications in BodyWrapper instance
bodyWrapper.setWatch(notificationsArray);
//Call disableNotification which takes BodyWrapper instance as parameter
let response = await notificationOperations.disableNotification(bodyWrapper);
Copiedvar listener = 0;
class DisableSpecificNotifications {

	async disableSpecificNotification()	{
		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 DisableSpecificNotifications().getToken(token)
        headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
        var requestMethod = "PATCH"
        var reqBody = {
            "watch": [
               {
                    "channel_id": "158001",
                    "events": [
                        "Leads.edit",
                        "Cases.all"
                    ],
                    "_delete_events": true
                }
            ]
        }
        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 DisableSpecificNotifications().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);
                }
            }
        })
    }
}

In the request, "@inputData.json" contains the sample input data.

Input JSON Keys

  • _delete_eventsboolean, mandatory

    To specify whether to disable specific notifications.

  • channel_idlong, mandatory

    The given value is sent back in notification URL body to make sure that the notification is for a particular channel.
    Possible values: Channel ID. Example: 1000000068001

  • events JSONArray["{module_api_name}.{operation}", "{module_api_name}.{operation}"], mandatory

    To subscribe based on particular operations on selected modules.
    Possible values: JSON Array of the provided format. Example: ["Leads.create","Sales_Orders.edit","Contacts.delete"]. Possible operation types - create, delete, edit, all

Note
  • _delete_events key is mandatory to disable specific notifications. If "_delete_events": false or _delete_events key is not given in the input, instant notifications will not be disabled.

  • channel_id and events keys are also mandatory.

Sample Input

Copied{
    "watch": [
       {
            "channel_id": "1000000058001",
            "events": [
                "Leads.edit",
                "Cases.all"
            ],
            "_delete_events": true
        }
    ]
}

Possible Errors

  • INVALID_DATA HTTP 400

    The user do not have permission to subscribe to the module.
    Resolution: Contact your system administrator

Sample Response

Copied{
    "watch": [
       {
            "code": "SUCCESS",
            "details": {
                "events": [
                   {
                        "resource_uri": "https://www.zohoapis.com/crm/v2/Leads",
                        "resource_id": "1000000000041",
                        "resource_name": "Leads",
                        "channel_id": "1000000058001"
                    },
                   {
                        "resource_uri": "https://www.zohoapis.com/crm/v2/Cases",
                        "resource_id": "1000000000089",
                        "resource_name": "Cases",
                        "channel_id": "1000000058001"
                    }
                ]
            },
            "message": "Successfully removed the subscribe details",
            "status": "success"
        }
    ]
}