Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "data": [
# {
# "Company": "Zylker",
# "Email": "patricia.boyle2@zylker.com",
# "Industry": "ASP (Application Service Provider)",
# "No_of_Employees": 100,
# "Annual_Revenue": 10000,
# "Twitter": "patricia",
# "Website": "https://www.patriciaboyle.com",
# "Salutation": "Ms.",
# "First_Name": "Patricia",
# "Lead_Status": "Contacted",
# "$review": null,
# "Email_Opt_Out": true,
# "Mobile": "89898989893",
# "Last_Name": "Boyle",
# "Layout": {
# "name": "Standard",
# "id": "{{layout_id}}"
# },
# "Lead_Source": "Employee Referral"
# }
# ]
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "data[0].Company" "Zylker"
CkJsonObject_UpdateString $json "data[0].Email" "patricia.boyle2@zylker.com"
CkJsonObject_UpdateString $json "data[0].Industry" "ASP (Application Service Provider)"
CkJsonObject_UpdateInt $json "data[0].No_of_Employees" 100
CkJsonObject_UpdateInt $json "data[0].Annual_Revenue" 10000
CkJsonObject_UpdateString $json "data[0].Twitter" "patricia"
CkJsonObject_UpdateString $json "data[0].Website" "https://www.patriciaboyle.com"
CkJsonObject_UpdateString $json "data[0].Salutation" "Ms."
CkJsonObject_UpdateString $json "data[0].First_Name" "Patricia"
CkJsonObject_UpdateString $json "data[0].Lead_Status" "Contacted"
CkJsonObject_UpdateNull $json "data[0].$review"
CkJsonObject_UpdateBool $json "data[0].Email_Opt_Out" 1
CkJsonObject_UpdateString $json "data[0].Mobile" "89898989893"
CkJsonObject_UpdateString $json "data[0].Last_Name" "Boyle"
CkJsonObject_UpdateString $json "data[0].Layout.name" "Standard"
CkJsonObject_UpdateString $json "data[0].Layout.id" "{{layout_id}}"
CkJsonObject_UpdateString $json "data[0].Lead_Source" "Employee Referral"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
set resp [new_CkHttpResponse]
set success [CkHttp_HttpJson $http "POST" "https://domain.com/crm/v2.1/Leads/upsert" $json "application/json" $resp]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkHttpResponse $resp
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "data": [
# {
# "code": "SUCCESS",
# "duplicate_field": "Email",
# "action": "update",
# "details": {
# "Modified_Time": "2021-05-05T07:23:46+00:00",
# "Modified_By": {
# "name": "Patricia",
# "id": "738964000000291009"
# },
# "Created_Time": "2021-05-05T07:23:06+00:00",
# "id": "738964000002118182",
# "Created_By": {
# "name": "Patricia",
# "id": "738964000000291009"
# }
# },
# "message": "record updated",
# "status": "success"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set code [CkJsonObject_stringOf $jResp "data[i].code"]
set duplicate_field [CkJsonObject_stringOf $jResp "data[i].duplicate_field"]
set action [CkJsonObject_stringOf $jResp "data[i].action"]
set Modified_Time [CkJsonObject_stringOf $jResp "data[i].details.Modified_Time"]
set Name [CkJsonObject_stringOf $jResp "data[i].details.Modified_By.name"]
set Id [CkJsonObject_stringOf $jResp "data[i].details.Modified_By.id"]
set Created_Time [CkJsonObject_stringOf $jResp "data[i].details.Created_Time"]
set detailsId [CkJsonObject_stringOf $jResp "data[i].details.id"]
set Created_ByName [CkJsonObject_stringOf $jResp "data[i].details.Created_By.name"]
set Created_ById [CkJsonObject_stringOf $jResp "data[i].details.Created_By.id"]
set message [CkJsonObject_stringOf $jResp "data[i].message"]
set status [CkJsonObject_stringOf $jResp "data[i].status"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-d '{
"data": [
{
"Company": "Zylker",
"Email": "patricia.boyle2@zylker.com",
"Industry": "ASP (Application Service Provider)",
"No_of_Employees": 100,
"Annual_Revenue": 10000,
"Twitter": "patricia",
"Website": "https://www.patriciaboyle.com",
"Salutation": "Ms.",
"First_Name": "Patricia",
"Lead_Status": "Contacted",
"$review": null,
"Email_Opt_Out": true,
"Mobile": "89898989893",
"Last_Name": "Boyle",
"Layout": {
"name": "Standard",
"id": "{{layout_id}}"
},
"Lead_Source": "Employee Referral"
}
]
}'
https://domain.com/crm/v2.1/Leads/upsert
Postman Collection Item JSON
{
"name": "Leads",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"Company\": \"Zylker\",\n \"Email\": \"patricia.boyle2@zylker.com\",\n \"Industry\": \"ASP (Application Service Provider)\",\n \"No_of_Employees\": 100,\n \"Annual_Revenue\": 10000,\n \"Twitter\": \"patricia\",\n \"Website\": \"https://www.patriciaboyle.com\",\n \"Salutation\": \"Ms.\",\n \"First_Name\": \"Patricia\",\n \"Lead_Status\": \"Contacted\",\n \"$review\": null,\n \"Email_Opt_Out\": true,\n \"Mobile\": \"89898989893\",\n \"Last_Name\": \"Boyle\",\n \"Layout\": {\n \"name\": \"Standard\",\n \"id\": \"{{layout_id}}\"\n },\n \"Lead_Source\": \"Employee Referral\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/Leads/upsert",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads",
"upsert"
]
},
"description": "To upsert records in the Leads module."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"Company\": \"Zylker\",\n \"Email\": \"patricia.boyle2@zylker.com\",\n \"Industry\": \"ASP (Application Service Provider)\",\n \"No_of_Employees\": 100,\n \"Annual_Revenue\": 10000,\n \"Twitter\": \"patricia\",\n \"Website\": \"https://www.patriciaboyle.com\",\n \"Salutation\": \"Ms.\",\n \"First_Name\": \"Patricia\",\n \"Lead_Status\": \"Contacted\",\n \"$review\": null,\n \"Email_Opt_Out\": true,\n \"Mobile\": \"89898989893\",\n \"Last_Name\": \"Boyle\",\n \"Lead_Source\": \"Employee Referral\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/Leads/upsert",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads",
"upsert"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 07:23:46 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "369"
},
{
"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-05T07:39:40+00:00"
},
{
"key": "clientVersion",
"value": "4009533"
},
{
"key": "clientsubVersion",
"value": "cfa914635a0a376a1322139140e8bf37"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"code\": \"SUCCESS\",\n \"duplicate_field\": \"Email\",\n \"action\": \"update\",\n \"details\": {\n \"Modified_Time\": \"2021-05-05T07:23:46+00:00\",\n \"Modified_By\": {\n \"name\": \"Patricia\",\n \"id\": \"738964000000291009\"\n },\n \"Created_Time\": \"2021-05-05T07:23:06+00:00\",\n \"id\": \"738964000002118182\",\n \"Created_By\": {\n \"name\": \"Patricia\",\n \"id\": \"738964000000291009\"\n }\n },\n \"message\": \"record updated\",\n \"status\": \"success\"\n }\n ]\n}"
},
{
"name": "INVALID_MODULE",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"Company\": \"Zylker\",\n \"Email\": \"patricia.boyle2@zylker.com\",\n \"Industry\": \"ASP (Application Service Provider)\",\n \"No_of_Employees\": 100,\n \"Annual_Revenue\": 10000,\n \"Twitter\": \"patricia\",\n \"Website\": \"https://www.patriciaboyle.com\",\n \"Salutation\": \"Ms.\",\n \"First_Name\": \"Patricia\",\n \"Lead_Status\": \"Contacted\",\n \"$review\": null,\n \"Email_Opt_Out\": true,\n \"Mobile\": \"89898989893\",\n \"Last_Name\": \"Boyle\",\n \"Lead_Source\": \"Employee Referral\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/Lead/upsert",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Lead",
"upsert"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 07:24:16 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "133"
},
{
"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-05T07:39:40+00:00"
},
{
"key": "clientVersion",
"value": "4009533"
},
{
"key": "clientsubVersion",
"value": "cfa914635a0a376a1322139140e8bf37"
},
{
"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_MODULE\",\n \"details\": {\n \"resource_path_index\": 0\n },\n \"message\": \"the module name given seems to be invalid\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_DATA",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"Company\": \"Zylker\",\n \"Email\": \"patricia.boyle2@zylker.com\",\n \"Industry\": \"ASP (Application Service Provider)\",\n \"No_of_Employees\": 100,\n \"Annual_Revenue\": 10000,\n \"Twitter\": \"patricia\",\n \"Website\": \"https://www.patriciaboyle.com\",\n \"Salutation\": \"Ms.\",\n \"First_Name\": \"Patricia\",\n \"Lead_Status\": \"Contacted\",\n \"$review\": null,\n \"Email_Opt_Out\": true,\n \"Mobile\": 89898989893,\n \"Last_Name\": \"Boyle\",\n \"Lead_Source\": \"Employee Referral\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/Leads/upsert",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads",
"upsert"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 07:25:11 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "168"
},
{
"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-05T07:39:40+00:00"
},
{
"key": "clientVersion",
"value": "4009533"
},
{
"key": "clientsubVersion",
"value": "cfa914635a0a376a1322139140e8bf37"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"code\": \"INVALID_DATA\",\n \"details\": {\n \"expected_data_type\": \"phone\",\n \"api_name\": \"Mobile\",\n \"json_path\": \"$.data[0].Mobile\"\n },\n \"message\": \"invalid data\",\n \"status\": \"error\"\n }\n ]\n}"
},
{
"name": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "COPY",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"Company\": \"Zylker\",\n \"Email\": \"patricia.boyle2@zylker.com\",\n \"Industry\": \"ASP (Application Service Provider)\",\n \"No_of_Employees\": 100,\n \"Annual_Revenue\": 10000,\n \"Twitter\": \"patricia\",\n \"Website\": \"https://www.patriciaboyle.com\",\n \"Salutation\": \"Ms.\",\n \"First_Name\": \"Patricia\",\n \"Lead_Status\": \"Contacted\",\n \"$review\": null,\n \"Email_Opt_Out\": true,\n \"Mobile\": \"89898989893\",\n \"Last_Name\": \"Boyle\",\n \"Lead_Source\": \"Employee Referral\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/Leads/upsert",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads",
"upsert"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 07:25:50 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": "AUTHENTICATION FAILURE",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"Company\": \"Zylker\",\n \"Email\": \"patricia.boyle2@zylker.com\",\n \"Industry\": \"ASP (Application Service Provider)\",\n \"No_of_Employees\": 100,\n \"Annual_Revenue\": 10000,\n \"Twitter\": \"patricia\",\n \"Website\": \"https://www.patriciaboyle.com\",\n \"Salutation\": \"Ms.\",\n \"First_Name\": \"Patricia\",\n \"Lead_Status\": \"Contacted\",\n \"$review\": null,\n \"Email_Opt_Out\": true,\n \"Mobile\": \"89898989893\",\n \"Last_Name\": \"Boyle\",\n \"Lead_Source\": \"Employee Referral\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/Leads/upsert",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads",
"upsert"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 07:26:09 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": "OAUTH_SCOPE_MISMATCH",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"Company\": \"Zylker\",\n \"Email\": \"patricia.boyle2@zylker.com\",\n \"Industry\": \"ASP (Application Service Provider)\",\n \"No_of_Employees\": 100,\n \"Annual_Revenue\": 10000,\n \"Twitter\": \"patricia\",\n \"Website\": \"https://www.patriciaboyle.com\",\n \"Salutation\": \"Ms.\",\n \"First_Name\": \"Patricia\",\n \"Lead_Status\": \"Contacted\",\n \"$review\": null,\n \"Email_Opt_Out\": true,\n \"Mobile\": \"89898989893\",\n \"Last_Name\": \"Boyle\",\n \"Layout\": {\n \"name\": \"Standard\",\n \"id\": \"{{layout_id}}\"\n },\n \"Lead_Source\": \"Employee Referral\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/Leads/upsert",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads",
"upsert"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 07:32:39 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "113"
},
{
"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\": \"OAUTH_SCOPE_MISMATCH\",\n \"details\": {},\n \"message\": \"invalid oauth scope to access this URL\",\n \"status\": \"error\"\n}"
}
]
}
