Disable Notifications

Purpose

To stop all the instant notifications enabled by the user for a channel.

Request Details

Request URL

{api-domain}/crm/v2/actions/watch

Header

Authorization: Zoho-oauthtoken 100xx.d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.notifications.{operations_type}

Possible operation types

ALL - Full access to notification data
DELETE - Delete notification details

Sample Request

Copiedcurl "https://zylkercorp.zohoplatform.com/crm/v2/actions/watch?channel_ids=1000000068003,1000000068001,1000000068002"
-H "Authorization: Zoho-oauthtoken 100xx.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X DELETE
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://zylkercorp.zohoplatform.com/crm/v2/actions/watch"
        var parameters = new Map()
        var headers = new Map()
        var token = {
            clientId:"100xx.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://zylkercorp.zohoplatform.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://zylkercorp.zohoplatform.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://zylkercorp.zohoplatform.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://zylkercorp.zohoplatform.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://zylkercorp.zohoplatform.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://zylkercorp.zohoplatform.com/crm/v2/Deals",
                "resource_id": "1000000000047",
                "channel_id": "1000000068002"
            },
            "message": "Successfully un-subscribed from actions-watch",
            "status": "success"
        }
    ]
}