Update Specific Information of a Notification

Purpose

To update only specific details of a specific notification enabled by the user. All the provided details would be persisted and rest of the details will not be removed.

Endpoints

PATCH /actions/watch

Request Details

Request URL

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

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.notifications.{operation_type}

Possible operation types

ALL - Full access to the record
WRITE - Edit records in the module
UPDATE - Update records in the module

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v3/actions/watch"
-X PATCH
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@inputData.json"

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

Input JSON Keys

tokenString, optional
To ensure that the notification is sent from Zoho CRM, by sending back the given value in notification URL body. By using this value, user can validate the notifications. Maximum length of characters is 50.
Possible values: Example: TOKEN_FOR_VERIFICATION_OF_1000000068001
notify_urlString, optional
URL to be notified (POST request). Whenever any action gets triggered, the notification will be sent through this notify url.
Possible values: String values. Example: https://www.zoho.com/callback?authorization=Zoho-oauthtoken 1000.23dnsbbbh455jnn&key1=val1&key2=val2
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
channel_expiryString (ISO Date time), optional
To set the expiry time for instant notifications. Maximum of only one day from the time they were enabled. If it is not specified or set for more than a day, the default expiry time is for one hour.
Possible values: ISO Date time. Example: 2018-02-02T10:30:00+05:30
events JSONArray["{module_api_name}.{operation}", "{module_api_name}.{operation}"], optional
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
notify_on_related_actionboolean, optional
To enable notification when there is any action on any associated records. The default value is FALSE.

Sample Input

Copied{
    "watch": [
       {
            "channel_id": "1000000068001",
            "events": [
                "Solutions.create",
                "Price_Books.delete"
            ],
            "channel_expiry": "2018-02-02T11:30:00+05:30"
        },
       {
            "channel_id": "1000000068002",
            "events": [
                "Deals.edit"
            ],
            "channel_expiry": "2018-02-02T11:30:00+05:30"
        }
    ]
}

Sample Response

Copied{
    "watch": [
       {
            "code": "SUCCESS",
            "details": {
                "events": [
                   {
                        "channel_expiry": "2018-02-02T11:30:00+05:30",
                        "resource_uri": "https://www.zohoapis.com/crm/v3/Solutions",
                        "resource_id": "1000000000091",
                        "resource_name": "Solutions",
                        "channel_id": "1000000068001"
                    },
                   {
                        "channel_expiry": "2018-02-02T11:30:00+05:30",
                        "resource_uri": "https://www.zohoapis.com/crm/v3/Price_Books",
                        "resource_id": "1000000000097",
                        "resource_name": "Price_Books",
                        "channel_id": "1000000068001"
                    }
                ]
            },
            "message": "Successfully updated the subscribe details",
            "status": "success"
        },
       {
            "code": "SUCCESS",
            "details": {
                "events": [
                   {
                        "channel_expiry": "2018-02-02T11:30:00+05:30",
                        "resource_uri": "https://www.zohoapis.com/crm/v3/Deals",
                        "resource_id": "1000000000047",
                        "resource_name": "Deals",
                        "channel_id": "1000000068002"
                    }
                ]
            },
            "message": "Successfully updated the subscribe details",
            "status": "success"
        }
    ]
}

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": [
                   {
                        "channel_expiry": "2018-02-02T11:30:00+05:30",
                        "resource_uri": "https://www.zohoapis.com/crm/v3/Solutions",
                        "resource_id": "1000000000091",
                        "resource_name": "Solutions",
                        "channel_id": "1000000068001"
                    },
                   {
                        "channel_expiry": "2018-02-02T11:30:00+05:30",
                        "resource_uri": "https://www.zohoapis.com/crm/v3/Price_Books",
                        "resource_id": "1000000000097",
                        "resource_name": "Price_Books",
                        "channel_id": "1000000068001"
                    }
                ]
            },
            "message": "Successfully updated the subscribe details",
            "status": "success"
        },
       {
            "code": "SUCCESS",
            "details": {
                "events": [
                   {
                        "channel_expiry": "2018-02-02T11:30:00+05:30",
                        "resource_uri": "https://www.zohoapis.com/crm/v3/Deals",
                        "resource_id": "1000000000047",
                        "resource_name": "Deals",
                        "channel_id": "1000000068002"
                    }
                ]
            },
            "message": "Successfully updated the subscribe details",
            "status": "success"
        }
    ]
}