Swift3 / Zoho CRM REST APIs / Update Specific Information of a Notification
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
// 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"
// }
// ]
// }
let json = CkoJsonObject()!
json.update("watch[0].channel_id", value: "1000000068001")
json.update("watch[0].events[0]", value: "Solutions.create")
json.update("watch[0].events[1]", value: "Price_Books.delete")
json.update("watch[0].channel_expiry", value: "2018-02-02T11:30:00+05:30")
json.update("watch[1].channel_id", value: "1000000068002")
json.update("watch[1].events[0]", value: "Deals.edit")
json.update("watch[1].channel_expiry", value: "2018-02-02T11:30:00+05:30")
// Adds the "Authorization: Bearer <access_token>" header.
http.authToken = "<access_token>"
let sbRequestBody = CkoStringBuilder()!
json.emitSb(sbRequestBody)
var resp: CkoHttpResponse? = http.pTextSb("PATCH", url: "https://domain.com/crm/v2.1/actions/watch", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
if http.lastMethodSuccess == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp!.getBodySb(sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp!.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.header!)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var code: String?
var message: String?
var status: String?
var j: Int
var count_j: Int
var channel_expiry: String?
var resource_uri: String?
var resource_id: String?
var resource_name: String?
var channel_id: String?
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "watch").intValue
while i < count_i {
jResp.i = i
code = jResp.string(of: "watch[i].code")
message = jResp.string(of: "watch[i].message")
status = jResp.string(of: "watch[i].status")
j = 0
count_j = jResp.size(ofArray: "watch[i].details.events").intValue
while j < count_j {
jResp.j = j
channel_expiry = jResp.string(of: "watch[i].details.events[j].channel_expiry")
resource_uri = jResp.string(of: "watch[i].details.events[j].resource_uri")
resource_id = jResp.string(of: "watch[i].details.events[j].resource_id")
resource_name = jResp.string(of: "watch[i].details.events[j].resource_name")
channel_id = jResp.string(of: "watch[i].details.events[j].channel_id")
j = j + 1
}
i = i + 1
}
}
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}"
}
]
}
