Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$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"
// }
// ]
// }
$json = new CkJsonObject();
$json->UpdateString('data[0].Company','Zylker');
$json->UpdateString('data[0].Email','patricia.boyle2@zylker.com');
$json->UpdateString('data[0].Industry','ASP (Application Service Provider)');
$json->UpdateInt('data[0].No_of_Employees',100);
$json->UpdateInt('data[0].Annual_Revenue',10000);
$json->UpdateString('data[0].Twitter','patricia');
$json->UpdateString('data[0].Website','https://www.patriciaboyle.com');
$json->UpdateString('data[0].Salutation','Ms.');
$json->UpdateString('data[0].First_Name','Patricia');
$json->UpdateString('data[0].Lead_Status','Contacted');
$json->UpdateNull('data[0].$review');
$json->UpdateBool('data[0].Email_Opt_Out',true);
$json->UpdateString('data[0].Mobile','89898989893');
$json->UpdateString('data[0].Last_Name','Boyle');
$json->UpdateString('data[0].Layout.name','Standard');
$json->UpdateString('data[0].Layout.id','{{layout_id}}');
$json->UpdateString('data[0].Lead_Source','Employee Referral');
// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
// resp is a CkHttpResponse
$resp = $http->PostJson3('https://domain.com/crm/v2.1/Leads/upsert','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
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
$i = 0;
$count_i = $jResp->SizeOfArray('data');
while ($i < $count_i) {
$jResp->put_I($i);
$code = $jResp->stringOf('data[i].code');
$duplicate_field = $jResp->stringOf('data[i].duplicate_field');
$action = $jResp->stringOf('data[i].action');
$Modified_Time = $jResp->stringOf('data[i].details.Modified_Time');
$Name = $jResp->stringOf('data[i].details.Modified_By.name');
$Id = $jResp->stringOf('data[i].details.Modified_By.id');
$Created_Time = $jResp->stringOf('data[i].details.Created_Time');
$detailsId = $jResp->stringOf('data[i].details.id');
$Created_ByName = $jResp->stringOf('data[i].details.Created_By.name');
$Created_ById = $jResp->stringOf('data[i].details.Created_By.id');
$message = $jResp->stringOf('data[i].message');
$status = $jResp->stringOf('data[i].status');
$i = $i + 1;
}
?>
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}"
}
]
}
