Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "operation": "insert",
; "ignore_empty": true,
; "callback": {
; "url": "https://www.zoho.com/in/crm/",
; "method": "post"
; },
; "resource": [
; {
; "type": "data",
; "module": "Leads",
; "file_id": "{{file_id}}",
; "field_mappings": [
; {
; "api_name": "Last_Name",
; "index": 0
; },
; {
; "api_name": "Owner",
; "index": 1
; },
; {
; "api_name": "Date_3",
; "index": 2,
; "format": "yyyy/MM/dd"
; },
; {
; "api_name": "Mobile",
; "index": 3
; },
; {
; "api_name": "Layout",
; "index": 4
; }
; ]
; }
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"operation","insert")
CkJsonObject::ckUpdateBool(json,"ignore_empty",1)
CkJsonObject::ckUpdateString(json,"callback.url","https://www.zoho.com/in/crm/")
CkJsonObject::ckUpdateString(json,"callback.method","post")
CkJsonObject::ckUpdateString(json,"resource[0].type","data")
CkJsonObject::ckUpdateString(json,"resource[0].module","Leads")
CkJsonObject::ckUpdateString(json,"resource[0].file_id","{{file_id}}")
CkJsonObject::ckUpdateString(json,"resource[0].field_mappings[0].api_name","Last_Name")
CkJsonObject::ckUpdateInt(json,"resource[0].field_mappings[0].index",0)
CkJsonObject::ckUpdateString(json,"resource[0].field_mappings[1].api_name","Owner")
CkJsonObject::ckUpdateInt(json,"resource[0].field_mappings[1].index",1)
CkJsonObject::ckUpdateString(json,"resource[0].field_mappings[2].api_name","Date_3")
CkJsonObject::ckUpdateInt(json,"resource[0].field_mappings[2].index",2)
CkJsonObject::ckUpdateString(json,"resource[0].field_mappings[2].format","yyyy/MM/dd")
CkJsonObject::ckUpdateString(json,"resource[0].field_mappings[3].api_name","Mobile")
CkJsonObject::ckUpdateInt(json,"resource[0].field_mappings[3].index",3)
CkJsonObject::ckUpdateString(json,"resource[0].field_mappings[4].api_name","Layout")
CkJsonObject::ckUpdateInt(json,"resource[0].field_mappings[4].index",4)
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/crm/bulk/v2/write","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "status": "success",
; "code": "SUCCESS",
; "message": "success",
; "details": {
; "id": "4150868000005392002",
; "created_by": {
; "id": "4150868000000225013",
; "name": "Patricia Boyle"
; }
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
status.s = CkJsonObject::ckStringOf(jResp,"status")
code.s = CkJsonObject::ckStringOf(jResp,"code")
message.s = CkJsonObject::ckStringOf(jResp,"message")
Id.s = CkJsonObject::ckStringOf(jResp,"details.id")
Created_byId.s = CkJsonObject::ckStringOf(jResp,"details.created_by.id")
Name.s = CkJsonObject::ckStringOf(jResp,"details.created_by.name")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-d '{
"operation": "insert",
"ignore_empty": true,
"callback": {
"url": "https://www.zoho.com/in/crm/",
"method": "post"
},
"resource": [
{
"type": "data",
"module": "Leads",
"file_id": "{{file_id}}",
"field_mappings": [
{
"api_name": "Last_Name",
"index": 0
},
{
"api_name": "Owner",
"index": 1
},
{
"api_name": "Date_3",
"index": 2,
"format": "yyyy/MM/dd"
},
{
"api_name": "Mobile",
"index": 3
},
{
"api_name": "Layout",
"index": 4
}
]
}
]
}'
https://domain.com/crm/bulk/v2/write
Postman Collection Item JSON
{
"name": "Create Bulk Write Job",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"operation\": \"insert\",\n \"ignore_empty\": true,\n \"callback\": {\n \"url\": \"https://www.zoho.com/in/crm/\",\n \"method\": \"post\"\n },\n \"resource\": [\n {\n \"type\": \"data\",\n \"module\": \"Leads\",\n \"file_id\": \"{{file_id}}\",\n \"field_mappings\": [\n {\n \"api_name\": \"Last_Name\",\n \"index\": 0\n },\n {\n \"api_name\": \"Owner\",\n \"index\": 1\n },\n {\n \"api_name\": \"Date_3\",\n \"index\": 2,\n \"format\": \"yyyy/MM/dd\"\n },\n {\n \"api_name\": \"Mobile\",\n \"index\": 3\n },\n {\n \"api_name\": \"Layout\",\n \"index\": 4\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/bulk/v2/write",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"bulk",
"v2",
"write"
]
},
"description": "To create a bulk write job to import records into CRM."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"operation\": \"insert\",\n \"ignore_empty\": true,\n \"callback\": {\n \"url\": \"https://www.zoho.com/in/crm/\",\n \"method\": \"post\"\n },\n \"resource\": [\n {\n \"type\": \"data\",\n \"module\": \"Leads\",\n \"file_id\": \"4150868000005379001\",\n \"field_mappings\": [\n {\n \"api_name\": \"Last_Name\",\n \"index\": 0\n },\n {\n \"api_name\": \"Owner\",\n \"index\": 1\n },\n {\n \"api_name\": \"Date_3\",\n \"index\": 2,\n \"format\": \"yyyy/MM/dd\"\n },\n {\n \"api_name\": \"Mobile\",\n \"index\": 3\n },\n {\n \"api_name\": \"Layout\",\n \"index\": 4\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/bulk/v2/write",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"bulk",
"v2",
"write"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 05:30:58 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"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-13T12:00:55+05:30"
},
{
"key": "vary",
"value": "accept-encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000"
}
],
"cookie": [
],
"body": "{\n \"status\": \"success\",\n \"code\": \"SUCCESS\",\n \"message\": \"success\",\n \"details\": {\n \"id\": \"4150868000005392002\",\n \"created_by\": {\n \"id\": \"4150868000000225013\",\n \"name\": \"Patricia Boyle\"\n }\n }\n}"
},
{
"name": "MISSING_REQUIRED_KEY",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"operation\": \"insert\",\n \"ignore_empty\": true,\n \"callback\": {\n \"url\": \"https://www.zoho.com/in/crm/\",\n \"method\": \"post\"\n },\n \"resource\": [\n {\n \"type\": \"data\",\n \"module\": \"Leads\",\n \"field_mappings\": [\n {\n \"api_name\": \"Last_Name\",\n \"index\": 0\n },\n {\n \"api_name\": \"Owner\",\n \"index\": 1\n },\n {\n \"api_name\": \"Date_3\",\n \"index\": 2,\n \"format\": \"yyyy/MM/dd\"\n },\n {\n \"api_name\": \"Mobile\",\n \"index\": 3\n },\n {\n \"api_name\": \"Layout\",\n \"index\": 4\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/bulk/v2/write",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"bulk",
"v2",
"write"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 05:31:15 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"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-13T12:00:55+05:30"
},
{
"key": "vary",
"value": "accept-encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
}
],
"cookie": [
],
"body": "{\n \"status\": \"error\",\n \"code\": \"MISSING_REQUIRED_KEY\",\n \"message\": \"required key fileid is not found in request body.\",\n \"details\": {}\n}"
},
{
"name": "INVALID_CALLBACK_URL",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"operation\": \"insert\",\n \"ignore_empty\": true,\n \"callback\": {\n \"url\": \"http://requestbin.fullcontact.com\",\n \"method\": \"post\"\n },\n \"resource\": [\n {\n \"type\": \"data\",\n \"module\": \"Leads\",\n \"file_id\": \"4150868000005379001\",\n \"field_mappings\": [\n {\n \"api_name\": \"Last_Name\",\n \"index\": 0\n },\n {\n \"api_name\": \"Owner\",\n \"index\": 1\n },\n {\n \"api_name\": \"Date_3\",\n \"index\": 2,\n \"format\": \"yyyy/MM/dd\"\n },\n {\n \"api_name\": \"Mobile\",\n \"index\": 3\n },\n {\n \"api_name\": \"Layout\",\n \"index\": 4\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/bulk/v2/write",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"bulk",
"v2",
"write"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 05:31:50 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"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-13T12:00:55+05:30"
},
{
"key": "vary",
"value": "accept-encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
}
],
"cookie": [
],
"body": "{\n \"status\": \"error\",\n \"code\": \"INVALID_CALLBACK_URL\",\n \"message\": \"Invalid URL 'http://requestbin.fullcontact.com' for callback.\",\n \"details\": {\n \"reason\": \"possible ssrf attempt\"\n }\n}"
},
{
"name": "FILE_NOT_SUPPORTED",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"operation\": \"insert\",\n \"ignore_empty\": true,\n \"callback\": {\n \"url\": \"https://www.zoho.com/in/crm/\",\n \"method\": \"post\"\n },\n \"resource\": [\n {\n \"type\": \"data\",\n \"module\": \"Leads\",\n \"file_id\": \"415086800000537900\",\n \"field_mappings\": [\n {\n \"api_name\": \"Last_Name\",\n \"index\": 0\n },\n {\n \"api_name\": \"Owner\",\n \"index\": 1\n },\n {\n \"api_name\": \"Date_3\",\n \"index\": 2,\n \"format\": \"yyyy/MM/dd\"\n },\n {\n \"api_name\": \"Mobile\",\n \"index\": 3\n },\n {\n \"api_name\": \"Layout\",\n \"index\": 4\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/bulk/v2/write",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"bulk",
"v2",
"write"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 05:32:27 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"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-13T12:00:55+05:30"
},
{
"key": "vary",
"value": "accept-encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
}
],
"cookie": [
],
"body": "{\n \"status\": \"error\",\n \"code\": \"FILE_NOT_SUPPORTED\",\n \"message\": \"File not supported for bulk write\",\n \"details\": {}\n}"
}
]
}
