Disable specific notifications

Disable notifications for specific events in a channel. This endpoint deletes only the events you specify in the events array of the request body.

Endpoints

PATCH /actions/watch

Request URL

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

Choose a domain-specific URL to replace {api-domain}

You can use a domain-specific URL to access Bigin resources. Based on the data center in which the Bigin account's resources are available, replace {api-domain} in the preceding request with one of the following API domain URLs:

For US: https://www.zohoapis.com
For EU: https://www.zohoapis.eu
For AU: https://www.zohoapis.com.au
For IN: https://www.zohoapis.in
For CN: https://www.zohoapis.com.cn
For JP: https://www.zohoapis.jp

For more information, read Multi DC Support.

Authorization

For this endpoint, pass the access token as an authorization header. Read OAuth Authentication for more information about access tokens.

Authorization: Zoho-oauthtoken <ACCESS_TOKEN>

You must authenticate using an access token that's associated with the following scope:

ZohoBigin.notifications.ALL
ZohoBigin.notifications.WRITE
ZohoBigin.notifications.UPDATE

Sample request

Copiedcurl "https://www.zohoapis.com/bigin/v2/actions/watch" \
-X PATCH \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf" \
-d "@notif-webhook-disable-specific-events.json"

Request parameters

The available request parameters are provided below:

Body parameters

_delete_events booleanRequired

Indicates whether you want to delete the events specified in the events key. If the value is set to true, all notifications for the events will be deleted. On the other hand, if the value is false or if this key is not included in the input, notifications will not be disabled.

channel_id stringRequired

This is the unique identifier of a channel that's set while enabling a notification.

events jsonarrayRequired

A JSON array containing the module API name and operation type (e.g., Contacts.create or Pipelines.edit) for receiving notifications for specific actions within Bigin. If you set the value for the "_delete_events" key as true, the specified values in this JSON array will be removed.

For example:

"events": [
"Contacts.create",
"Accounts.edit",
],
"_delete_events": true

Sample request body

Copied{
    "watch": [
        {
            "channel_id": "1001",
            "events": [
				"Contacts.edit",
				"Pipelines.edit"
			],
            "_delete_events": true
		}
	]
}

Sample response

Copied{
    "watch": [
        {
            "code": "SUCCESS",
            "details": {
                "events": [
                    {
                        "resource_uri": "https://www.zohoapis.com/bigin/v2/Contacts",
                        "resource_id": "5436046000000002179",
                        "resource_name": "Contacts",
                        "channel_id": "1001"
					},
                    {
                        "resource_uri": "https://www.zohoapis.com/bigin/v2/Pipelines",
                        "resource_id": "5436046000000002181",
                        "resource_name": "Pipelines",
                        "channel_id": "1001"
					}
				]
            },
            "message": "Successfully removed the subscribe details",
            "status": "success"
		}
	]
}