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
Request Details
Request URL
{api-domain}/crm/{version}/actions/watch
Supported modules
Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Meetings, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Appointments, Appointments Rescheduled History, Services, and Custom
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/v6/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
This value is sent back in the callback to ensure that the notification is from Zoho CRM. The maximum character length is 50.
Possible values: Example: TOKEN_FOR_VERIFICATION_OF_1000000068001 - notify_urlString, mandatory
The URL to be notified (POST request) about the action that took place in the module.
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 callback 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
Represents the expiry time for instant notifications. The value can be a 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: 2023-02-02T10:30:00+05:30 - return_affected_field_valuesboolean, optional
It returns the affected fields with their values and corresponding record IDs if return_affected_field_values in the input is true. If false, the return_affected_field_values key will not be shown in the response.
- eventsJSONArray, mandatory
To subscribe based on particular operations on selected modules.
Possible values: JSON Array of the format ["{module_api_name}.{operation}", "{module_api_name}.{operation}"]. Example: ["Leads.create","Sales_Orders.edit","Contacts.delete","users.all"]. Possible operation types - create, delete, edit, all - notification_conditionJSONArray, optional
To raise a notification only when an event occurs on certain fields of the module.
This array contains the following keys:- type - string, mandatory - Indicates that a notification is raised based on field updates. The value is field_selection.
- module - JSON object, mandatory - The API name and ID of the module on whose field events you want to receive notifications.
- field_selection - JSON object, mandatory - Contains a maximum of two objects with each object having the following keys:
- group_operator - string, mandatory - The supported operators are and and or. You can group the fields using these operators.
group - JSON array, mandatory - Every field JSON object contains the API name and ID of the field in the module. You will receive a notification whenever any action happens on these fields based on their group operator.
Note: You can have a maximum of 10 fields in the group array, irrespective of how you have grouped them.
- notify_on_related_actionboolean, optional
To enable notification when there is any action on any associated records. The default value is TRUE.
To get notification on a URL
- On trigger of any notification-enabled event in a module, Zoho CRM sends a notification to the user through the notify URL.
Sample Input
Copied{
"watch": [
{
"channel_id": "1000000068002",
"events": [
"Deals.edit"
],
"notification_condition": [
{
"type": "field_selection",
"module": {
"api_name": "Deals",
"id": "554023000000000131"
},
"field_selection": {
"group_operator": "or",
"group": [
{
"field": {
"api_name": "Stage",
"id": "554023000000000525"
}
},
{
"group_operator": "and",
"group": [
{
"field": {
"api_name": "Account_Name",
"id": "554023000000000523"
}
},
{
"field": {
"api_name": "Lead_Source",
"id": "554023000000000535"
}
}
]
}
]
}
}
],
"channel_expiry": "2023-12-31T09:58:09+05:30",
"token": "deals.all.notif",
"notify_url": "https://www.zoho.com/callback?authorization=Zoho-oauthtoken 1000.23dnsbbbh455jnn&key1=val1&key2=val2"
}
]
}Sample Response
Copied{
"watch": [
{
"code": "SUCCESS",
"details": {
"events": [
{
"channel_expiry": "2023-08-02T16:59:50-11:00",
"resource_uri": "https://www.zohoapis.com.com/crm/v2/Deals",
"resource_id": "554023000000000131",
"resource_name": "Deals",
"channel_id": "10000"
}
]
},
"message": "Successfully updated the subscribe details",
"status": "success"
}
]
}Response JSON Keys
- serverinteger
Represents the server time when the notification was sent to the notify URL.
- affected_valuesJSON array
It returns the affected fields with their values and corresponding record IDs if return_affected_field_values in the input is true and the value is false, return_affected_field_values JSON array will not be shown in the response.
- query_paramsJSON object
Represents the parameters if any were specified in the notification request.
- resource_uriJSON object
Represents the URI of the module you have specified to receive notifications when certain actions are performed in the module.
- idsJSON array
Represents the unique IDs of the affected records.
- affected_fieldsJSON array
Returns the modified fields (affected fields) in a specific record. Note the subforms, participants, and product_details fields will be ignored in the response.
- operationstring
Represents the operation performed on the module.
- modulestring
Represents the module you have subscribed from which you want to be notified of any changes.
- channel_idlong
Represents the subscribed channel ID.
- tokenstring
Represents the value received in the callback to ensure that the notification is from Zoho CRM.
Sample response received via notify URL for a record update in a module
Copied{
"server_time": 1719309544639,
"affected_values": [
{
"record_id": "5725767000003093005",
"values": {
"Probability": 75,
"Stage": "Proposal/Price Quote"
}
}
],
"query_params": {
"key1": "val1",
"key2": "val2",
"?authorization": "Zoho-oauthtoken 1000.23dnsbbbh455jnn"
},
"module": "Deals",
"resource_uri": "https://www.zohoapis.com/crm/v2/Deals",
"ids": [
"5725767000003093005"
],
"affected_fields": [
{
"5725767000003093005": [
"Stage",
"Probability"
]
}
],
"operation": "update",
"channel_id": "1000000068002",
"token": "TOKEN_FOR_VERIFICATION_OF_1000000068001"
}