SQL Server / Zoho CRM REST APIs / Update Specific Information of a Notification
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "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"
-- }
-- ]
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'watch[0].channel_id', '1000000068001'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'watch[0].events[0]', 'Solutions.create'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'watch[0].events[1]', 'Price_Books.delete'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'watch[0].channel_expiry', '2018-02-02T11:30:00+05:30'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'watch[1].channel_id', '1000000068002'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'watch[1].events[0]', 'Deals.edit'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'watch[1].channel_expiry', '2018-02-02T11:30:00+05:30'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @sbRequestBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PATCH', 'https://domain.com/crm/v2.1/actions/watch', @sbRequestBody, 'utf-8', 'application/json', 0, 0
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "watch": [
-- {
-- "code": "SUCCESS",
-- "details": {
-- "events": [
-- {
-- "channel_expiry": "2021-05-11T15:03:32+05:30",
-- "resource_uri": "https://www.zohoapis.com/crm/v2/Solutions",
-- "resource_id": "4150868000000002211",
-- "resource_name": "Solutions",
-- "channel_id": "1000000068001"
-- },
-- {
-- "channel_expiry": "2021-05-11T15:03:32+05:30",
-- "resource_uri": "https://www.zohoapis.com/crm/v2/Price_Books",
-- "resource_id": "4150868000000002217",
-- "resource_name": "Price_Books",
-- "channel_id": "1000000068001"
-- }
-- ]
-- },
-- "message": "Successfully updated the subscribe details",
-- "status": "success"
-- },
-- {
-- "code": "SUCCESS",
-- "details": {
-- "events": [
-- {
-- "channel_expiry": "2021-05-11T15:03:32+05:30",
-- "resource_uri": "https://www.zohoapis.com/crm/v2/Deals",
-- "resource_id": "4150868000000002181",
-- "resource_name": "Deals",
-- "channel_id": "1000000068002"
-- }
-- ]
-- },
-- "message": "Successfully updated the subscribe details",
-- "status": "success"
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @code nvarchar(4000)
DECLARE @message nvarchar(4000)
DECLARE @status nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @channel_expiry nvarchar(4000)
DECLARE @resource_uri nvarchar(4000)
DECLARE @resource_id nvarchar(4000)
DECLARE @resource_name nvarchar(4000)
DECLARE @channel_id nvarchar(4000)
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'watch'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @code OUT, 'watch[i].code'
EXEC sp_OAMethod @jResp, 'StringOf', @message OUT, 'watch[i].message'
EXEC sp_OAMethod @jResp, 'StringOf', @status OUT, 'watch[i].status'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'watch[i].details.events'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @channel_expiry OUT, 'watch[i].details.events[j].channel_expiry'
EXEC sp_OAMethod @jResp, 'StringOf', @resource_uri OUT, 'watch[i].details.events[j].resource_uri'
EXEC sp_OAMethod @jResp, 'StringOf', @resource_id OUT, 'watch[i].details.events[j].resource_id'
EXEC sp_OAMethod @jResp, 'StringOf', @resource_name OUT, 'watch[i].details.events[j].resource_name'
EXEC sp_OAMethod @jResp, 'StringOf', @channel_id OUT, 'watch[i].details.events[j].channel_id'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X PATCH
-H "Authorization: Bearer <access_token>"
-d '{
"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"
}
]
}'
https://domain.com/crm/v2.1/actions/watch
Postman Collection Item JSON
{
"name": "Update Specific Information of a Notification",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "PATCH",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"watch\": [\n {\n \"channel_id\": \"1000000068001\",\n \"events\": [\n \"Solutions.create\",\n \"Price_Books.delete\"\n ],\n \"channel_expiry\": \"2018-02-02T11:30:00+05:30\"\n },\n {\n \"channel_id\": \"1000000068002\",\n \"events\": [\n \"Deals.edit\"\n ],\n \"channel_expiry\": \"2018-02-02T11:30:00+05:30\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/actions/watch",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"actions",
"watch"
]
},
"description": "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."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "PATCH",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"watch\": [\n {\n \"channel_id\": \"1000000068001\",\n \"events\": [\n \"Solutions.create\",\n \"Price_Books.delete\"\n ],\n \"channel_expiry\": \"2018-02-02T11:30:00+05:30\"\n },\n {\n \"channel_id\": \"1000000068002\",\n \"events\": [\n \"Deals.edit\"\n ],\n \"channel_expiry\": \"2018-02-02T11:30:00+05:30\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/actions/watch",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"actions",
"watch"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 07:33:32 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "836"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-11T14:00:30+05:30"
},
{
"key": "clientVersion",
"value": "4019232"
},
{
"key": "clientsubVersion",
"value": "19804a82a902c9fa618d2b359b97e26a"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000"
}
],
"cookie": [
],
"body": "{\n \"watch\": [\n {\n \"code\": \"SUCCESS\",\n \"details\": {\n \"events\": [\n {\n \"channel_expiry\": \"2021-05-11T15:03:32+05:30\",\n \"resource_uri\": \"https://www.zohoapis.com/crm/v2/Solutions\",\n \"resource_id\": \"4150868000000002211\",\n \"resource_name\": \"Solutions\",\n \"channel_id\": \"1000000068001\"\n },\n {\n \"channel_expiry\": \"2021-05-11T15:03:32+05:30\",\n \"resource_uri\": \"https://www.zohoapis.com/crm/v2/Price_Books\",\n \"resource_id\": \"4150868000000002217\",\n \"resource_name\": \"Price_Books\",\n \"channel_id\": \"1000000068001\"\n }\n ]\n },\n \"message\": \"Successfully updated the subscribe details\",\n \"status\": \"success\"\n },\n {\n \"code\": \"SUCCESS\",\n \"details\": {\n \"events\": [\n {\n \"channel_expiry\": \"2021-05-11T15:03:32+05:30\",\n \"resource_uri\": \"https://www.zohoapis.com/crm/v2/Deals\",\n \"resource_id\": \"4150868000000002181\",\n \"resource_name\": \"Deals\",\n \"channel_id\": \"1000000068002\"\n }\n ]\n },\n \"message\": \"Successfully updated the subscribe details\",\n \"status\": \"success\"\n }\n ]\n}"
},
{
"name": "INVALID_URL_PATTERN",
"originalRequest": {
"method": "PATCH",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"watch\": [\n {\n \"channel_id\": \"1000000068001\",\n \"events\": [\n \"Solutions.create\",\n \"Price_Books.delete\"\n ],\n \"channel_expiry\": \"2018-02-02T11:30:00+05:30\"\n },\n {\n \"channel_id\": \"1000000068002\",\n \"events\": [\n \"Deals.edit\"\n ],\n \"channel_expiry\": \"2018-02-02T11:30:00+05:30\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/actions/watc",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"actions",
"watc"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 07:33:52 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "131"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-11T14:00:30+05:30"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_URL_PATTERN\",\n \"details\": {},\n \"message\": \"Please check if the URL trying to access is a correct one\",\n \"status\": \"error\"\n}"
},
{
"name": "AUTHENTICATION_FAILURE",
"originalRequest": {
"method": "PATCH",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"watch\": [\n {\n \"channel_id\": \"1000000068001\",\n \"events\": [\n \"Solutions.create\",\n \"Price_Books.delete\"\n ],\n \"channel_expiry\": \"2018-02-02T11:30:00+05:30\"\n },\n {\n \"channel_id\": \"1000000068002\",\n \"events\": [\n \"Deals.edit\"\n ],\n \"channel_expiry\": \"2018-02-02T11:30:00+05:30\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/actions/watch",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"actions",
"watch"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 07:36:22 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "98"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"AUTHENTICATION_FAILURE\",\n \"details\": {},\n \"message\": \"Authentication failed\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "COPY",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"watch\": [\n {\n \"channel_id\": \"1000000068001\",\n \"events\": [\n \"Solutions.create\",\n \"Price_Books.delete\"\n ],\n \"channel_expiry\": \"2018-02-02T11:30:00+05:30\"\n },\n {\n \"channel_id\": \"1000000068002\",\n \"events\": [\n \"Deals.edit\"\n ],\n \"channel_expiry\": \"2018-02-02T11:30:00+05:30\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/actions/watch",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"actions",
"watch"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 07:40:24 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "124"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Frame-Options",
"value": "deny"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_REQUEST_METHOD\",\n \"details\": {},\n \"message\": \"The http request method type is not a valid one\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_REQUEST",
"originalRequest": {
"method": "PATCH",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"watch\": [\n {\n \"channel_id\": \"1000000068001\",\n \"events\": [\n \"Solutions.create\",\n \"Price_Books.delete\"\n ],\n \"channel_expiry\": \"2018-02-02T11:30:00+05:30\"\n },\n {\n \"channel_id\": \"1000000068002\",\n \"events\": [\n \"Deals.edit\"\n ],\n \"channel_expiry\": \"2018-02-02T11:30:00+05:30\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/actions/watch",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"actions",
"watch"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 08:25:45 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "192"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_REQUEST\",\n \"details\": {},\n \"message\": \"unable to process your request. please verify whether you have entered proper method name, parameter and parameter values.\",\n \"status\": \"error\"\n}"
}
]
}
