Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; 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"
; }
; ]
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("data[0].Company","Zylker")
$oJson.UpdateString("data[0].Email","patricia.boyle2@zylker.com")
$oJson.UpdateString("data[0].Industry","ASP (Application Service Provider)")
$oJson.UpdateInt("data[0].No_of_Employees",100)
$oJson.UpdateInt("data[0].Annual_Revenue",10000)
$oJson.UpdateString("data[0].Twitter","patricia")
$oJson.UpdateString("data[0].Website","https://www.patriciaboyle.com")
$oJson.UpdateString("data[0].Salutation","Ms.")
$oJson.UpdateString("data[0].First_Name","Patricia")
$oJson.UpdateString("data[0].Lead_Status","Contacted")
$oJson.UpdateNull("data[0].$review")
$oJson.UpdateBool("data[0].Email_Opt_Out",True)
$oJson.UpdateString("data[0].Mobile","89898989893")
$oJson.UpdateString("data[0].Last_Name","Boyle")
$oJson.UpdateString("data[0].Layout.name","Standard")
$oJson.UpdateString("data[0].Layout.id","{{layout_id}}")
$oJson.UpdateString("data[0].Lead_Source","Employee Referral")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
Local $oResp = $oHttp.PostJson3("https://domain.com/crm/v2/Leads/upsert","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": [
; {
; "code": "SUCCESS",
; "duplicate_field": null,
; "action": "insert",
; "details": {
; "Modified_Time": "2021-05-11T12:56:03+00:00",
; "Modified_By": {
; "name": "Patricia Boyle",
; "id": "738964000000291009"
; },
; "Created_Time": "2021-05-11T12:56:03+00:00",
; "id": "738964000002148126",
; "Created_By": {
; "name": "Patricia Boyle",
; "id": "738964000000291009"
; }
; },
; "message": "record added",
; "status": "success"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sCode
Local $sDuplicate_field
Local $sAction
Local $sModified_Time
Local $sName
Local $sId
Local $sCreated_Time
Local $sDetailsId
Local $sCreated_ByName
Local $sCreated_ById
Local $sMessage
Local $status
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data")
While $i < $iCount_i
$oJResp.I = $i
$sCode = $oJResp.StringOf("data[i].code")
$sDuplicate_field = $oJResp.StringOf("data[i].duplicate_field")
$sAction = $oJResp.StringOf("data[i].action")
$sModified_Time = $oJResp.StringOf("data[i].details.Modified_Time")
$sName = $oJResp.StringOf("data[i].details.Modified_By.name")
$sId = $oJResp.StringOf("data[i].details.Modified_By.id")
$sCreated_Time = $oJResp.StringOf("data[i].details.Created_Time")
$sDetailsId = $oJResp.StringOf("data[i].details.id")
$sCreated_ByName = $oJResp.StringOf("data[i].details.Created_By.name")
$sCreated_ById = $oJResp.StringOf("data[i].details.Created_By.id")
$sMessage = $oJResp.StringOf("data[i].message")
$status = $oJResp.StringOf("data[i].status")
$i = $i + 1
Wend
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/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/Leads/upsert",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"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/Leads/upsert",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads",
"upsert"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:56:03 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "370"
},
{
"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-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-11T12:57:36+00:00"
},
{
"key": "clientVersion",
"value": "4023320"
},
{
"key": "clientsubVersion",
"value": "4d8b6ee4f7d1d284c930a4e807480c5c"
},
{
"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\": null,\n \"action\": \"insert\",\n \"details\": {\n \"Modified_Time\": \"2021-05-11T12:56:03+00:00\",\n \"Modified_By\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"738964000000291009\"\n },\n \"Created_Time\": \"2021-05-11T12:56:03+00:00\",\n \"id\": \"738964000002148126\",\n \"Created_By\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"738964000000291009\"\n }\n },\n \"message\": \"record added\",\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/Lead/upsert",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Lead",
"upsert"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:56:28 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "110"
},
{
"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-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-11T12:57:36+00:00"
},
{
"key": "clientVersion",
"value": "4023320"
},
{
"key": "clientsubVersion",
"value": "4d8b6ee4f7d1d284c930a4e807480c5c"
},
{
"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 \"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\": 123,\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/Leads/upsert",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads",
"upsert"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:56:59 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "136"
},
{
"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-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-11T12:57:36+00:00"
},
{
"key": "clientVersion",
"value": "4023320"
},
{
"key": "clientsubVersion",
"value": "4d8b6ee4f7d1d284c930a4e807480c5c"
},
{
"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\": \"email\",\n \"api_name\": \"Email\"\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/Leads/upsert",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads",
"upsert"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:57:15 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/Leads/upsert",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads",
"upsert"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:58:15 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": "NOT_APPROVED",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"Company\": \"Zylker\",\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/Leads/upsert",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads",
"upsert"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:58:42 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "147"
},
{
"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-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-11T13:58:39+00:00"
},
{
"key": "clientVersion",
"value": "4023320"
},
{
"key": "clientsubVersion",
"value": "4d8b6ee4f7d1d284c930a4e807480c5c"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"code\": \"NOT_APPROVED\",\n \"details\": {\n \"id\": \"738964000002148126\"\n },\n \"message\": \"Cannot update record that is not approved yet\",\n \"status\": \"error\"\n }\n ]\n}"
}
]
}
