Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
// 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"
// }
// ]
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"data[0].Company" value: @"Zylker"];
[json UpdateString: @"data[0].Email" value: @"patricia.boyle2@zylker.com"];
[json UpdateString: @"data[0].Industry" value: @"ASP (Application Service Provider)"];
[json UpdateInt: @"data[0].No_of_Employees" value: [NSNumber numberWithInt: 100]];
[json UpdateInt: @"data[0].Annual_Revenue" value: [NSNumber numberWithInt: 10000]];
[json UpdateString: @"data[0].Twitter" value: @"patricia"];
[json UpdateString: @"data[0].Website" value: @"https://www.patriciaboyle.com"];
[json UpdateString: @"data[0].Salutation" value: @"Ms."];
[json UpdateString: @"data[0].First_Name" value: @"Patricia"];
[json UpdateString: @"data[0].Lead_Status" value: @"Contacted"];
[json UpdateNull: @"data[0].$review"];
[json UpdateBool: @"data[0].Email_Opt_Out" value: YES];
[json UpdateString: @"data[0].Mobile" value: @"89898989893"];
[json UpdateString: @"data[0].Last_Name" value: @"Boyle"];
[json UpdateString: @"data[0].Layout.name" value: @"Standard"];
[json UpdateString: @"data[0].Layout.id" value: @"{{layout_id}}"];
[json UpdateString: @"data[0].Lead_Source" value: @"Employee Referral"];
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/crm/v2/Leads/upsert" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// 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
NSString *code = 0;
NSString *duplicate_field = 0;
NSString *action = 0;
NSString *Modified_Time = 0;
NSString *Name = 0;
NSString *Id = 0;
NSString *Created_Time = 0;
NSString *detailsId = 0;
NSString *Created_ByName = 0;
NSString *Created_ById = 0;
NSString *message = 0;
NSString *status = 0;
int i = 0;
int count_i = [[jResp SizeOfArray: @"data"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: 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/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}"
}
]
}
