Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()
var success: Bool
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "users": [
// {
// "role": "{{role_id}}",
// "first_name": "Patricia",
// "email": "Patricia@abcl.com",
// "profile": "{{profile_id}}",
// "last_name": "Boyle",
// "Currency": "AFN",
// "territories": [
// {
// "manager": true,
// "name": "North Zone",
// "id": "{{territory_id}}"
// },
// {
// "manager": true,
// "name": "South Zone",
// "id": "{{territory_id}}"
// }
// ]
// }
// ]
// }
let json = CkoJsonObject()
json.UpdateString("users[0].role", value: "{{role_id}}")
json.UpdateString("users[0].first_name", value: "Patricia")
json.UpdateString("users[0].email", value: "Patricia@abcl.com")
json.UpdateString("users[0].profile", value: "{{profile_id}}")
json.UpdateString("users[0].last_name", value: "Boyle")
json.UpdateString("users[0].Currency", value: "AFN")
json.UpdateBool("users[0].territories[0].manager", value: true)
json.UpdateString("users[0].territories[0].name", value: "North Zone")
json.UpdateString("users[0].territories[0].id", value: "{{territory_id}}")
json.UpdateBool("users[0].territories[1].manager", value: true)
json.UpdateString("users[0].territories[1].name", value: "South Zone")
json.UpdateString("users[0].territories[1].id", value: "{{territory_id}}")
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Content-Type", value: "application/json")
var resp: CkoHttpResponse? = http.PostJson3("https://domain.com/crm/v2/users", contentType: "application/json", json: json)
if http.LastMethodSuccess == false {
print("\(http.LastErrorText)")
return
}
let sbResponseBody = CkoStringBuilder()
resp!.GetBodySb(sbResponseBody)
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = resp!.StatusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.Header)")
print("Failed.")
resp = nil
return
}
resp = nil
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "users": [
// {
// "code": "SUCCESS",
// "details": {
// "id": "738964000002148003"
// },
// "message": "User 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
var code: String?
var Id: String?
var message: String?
var status: String?
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("users").intValue
while i < count_i {
jResp.I = i
code = jResp.StringOf("users[i].code")
Id = jResp.StringOf("users[i].details.id")
message = jResp.StringOf("users[i].message")
status = jResp.StringOf("users[i].status")
i = i + 1
}
}
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"users": [
{
"role": "{{role_id}}",
"first_name": "Patricia",
"email": "Patricia@abcl.com",
"profile": "{{profile_id}}",
"last_name": "Boyle",
"Currency": "AFN",
"territories": [
{
"manager": true,
"name": "North Zone",
"id": "{{territory_id}}"
},
{
"manager": true,
"name": "South Zone",
"id": "{{territory_id}}"
}
]
}
]
}'
https://domain.com/crm/v2/users
Postman Collection Item JSON
{
"name": "Add User",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"users\": [\n {\n \"role\": \"{{role_id}}\",\n \"first_name\": \"Patricia\",\n \"email\": \"Patricia@abcl.com\",\n \"profile\": \"{{profile_id}}\",\n \"last_name\": \"Boyle\",\n \"Currency\": \"AFN\",\n \"territories\": [\n {\n \"manager\": true,\n \"name\": \"North Zone\",\n \"id\": \"{{territory_id}}\"\n },\n {\n \"manager\": true,\n \"name\": \"South Zone\",\n \"id\": \"{{territory_id}}\"\n }\n ]\n }\n ]\n}"
},
"url": {
"raw": "{{api-domain}}/crm/v2/users",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"users"
]
},
"description": "To add a user to your organization."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"users\": [\n {\n \"role\": \"738964000000015966\",\n \"first_name\": \"Patricia\",\n \"email\": \"Patricia@abcl2.com\",\n \"profile\": \"738964000000015972\",\n \"last_name\": \"Boyle\"\n }\n ]\n}"
},
"url": {
"raw": "{{api-domain}}/crm/v2/users",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"users"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 11:57:41 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": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"users\": [\n {\n \"code\": \"SUCCESS\",\n \"details\": {\n \"id\": \"738964000002148003\"\n },\n \"message\": \"User added\",\n \"status\": \"success\"\n }\n ]\n}"
},
{
"name": "DUPLICATE_DATA",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"users\": [\n {\n \"role\": \"738964000000015966\",\n \"first_name\": \"Patricia\",\n \"email\": \"Patricia@abcl2.com\",\n \"profile\": \"738964000000015972\",\n \"last_name\": \"Boyle\"\n }\n ]\n}"
},
"url": {
"raw": "{{api-domain}}/crm/v2/users",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"users"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 11:58:01 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "191"
},
{
"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 \"users\": [\n {\n \"code\": \"DUPLICATE_DATA\",\n \"details\": {\n \"id\": \"738964000002148003\",\n \"email\": \"Patricia@abcl2.com\"\n },\n \"message\": \"Failed to add user since same email id is already present\",\n \"status\": \"error\"\n }\n ]\n}"
},
{
"name": "MANDATORY_NOT_FOUND",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"users\": [\n {\n \"role\": \"738964000000015966\",\n \"first_name\": \"Patricia\",\n \"email\": \"Patricia@abcl2.com\",\n \"profile\": \"738964000000015972\"\n }\n ]\n}"
},
"url": {
"raw": "{{api-domain}}/crm/v2/users",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"users"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 11:58:33 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "131"
},
{
"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 \"users\": [\n {\n \"code\": \"MANDATORY_NOT_FOUND\",\n \"details\": {\n \"api_name\": \"last_name\"\n },\n \"message\": \"required field not found\",\n \"status\": \"error\"\n }\n ]\n}"
},
{
"name": "INVALID_DATA",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"users\": [\n {\n \"role\": \"738964000000015966\",\n \"first_name\": \"Patricia\",\n \"email\": \"Patricia@abcl2.com\",\n \"profile\": \"738964000000015972\",\n \"last_name\": 123\n }\n ]\n}"
},
"url": {
"raw": "{{api-domain}}/crm/v2/users",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"users"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 11:58:54 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "140"
},
{
"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 \"users\": [\n {\n \"code\": \"INVALID_DATA\",\n \"details\": {\n \"expected_data_type\": \"text\",\n \"api_name\": \"last_name\"\n },\n \"message\": \"invalid data\",\n \"status\": \"error\"\n }\n ]\n}"
},
{
"name": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "COPY",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"users\": [\n {\n \"role\": \"738964000000015966\",\n \"first_name\": \"Patricia\",\n \"email\": \"Patricia@abcl.com\",\n \"profile\": \"738964000000015972\",\n \"last_name\": \"Boyle\"\n }\n ]\n}"
},
"url": {
"raw": "{{api-domain}}/crm/v2/users",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"users"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:00:03 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": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"users\": [\n {\n \"role\": \"738964000000015966\",\n \"first_name\": \"Patricia\",\n \"email\": \"Patricia@abcl.com\",\n \"profile\": \"738964000000015972\",\n \"last_name\": \"Boyle\"\n }\n ]\n}"
},
"url": {
"raw": "{{api-domain}}/crm/v2/users",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"users"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:00:20 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": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"users\": [\n {\n \"role\": \"{{role_id}}\",\n \"first_name\": \"Patricia\",\n \"email\": \"Patricia@abcl.com\",\n \"profile\": \"{{profile_id}}\",\n \"last_name\": \"Boyle\",\n \"Currency\": \"AFN\",\n \"territories\": [\n {\n \"manager\": true,\n \"name\": \"North Zone\",\n \"id\": \"{{territory_id}}\"\n },\n {\n \"manager\": true,\n \"name\": \"South Zone\",\n \"id\": \"{{territory_id}}\"\n }\n ]\n }\n ]\n}"
},
"url": {
"raw": "{{api-domain}}/crm/v2/users",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"users"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 06:32:35 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}"
}
]
}
