Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCode
LOCAL lcModified_Time
LOCAL lcName
LOCAL lcId
LOCAL lcCreated_Time
LOCAL lcDetailsId
LOCAL lcCreated_ByName
LOCAL lcCreated_ById
LOCAL lcMessage
LOCAL lcStatus
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* 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": [
* {
* "id": "{{record_id}}",
* "Languages": [
* {
* "id": "{{id of the subform record that does not need any update}}"
* },
* {
* "id": "{{id of the subform record}}",
* "Proficiency": "{{data to be updated}}",
* "Languages_Known": "{{data to be updated}}"
* }
* ],
* "Availability": [
* {
* "id": "{{id of the subform record that does not need any update}}"
* },
* {
* "id": "{{id of the subform record }}",
* "Weekdays": "{{Weekdays}}"
* }
* ]
* }
* ]
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("data[0].id","{{record_id}}")
loJson.UpdateString("data[0].Languages[0].id","{{id of the subform record that does not need any update}}")
loJson.UpdateString("data[0].Languages[1].id","{{id of the subform record}}")
loJson.UpdateString("data[0].Languages[1].Proficiency","{{data to be updated}}")
loJson.UpdateString("data[0].Languages[1].Languages_Known","{{data to be updated}}")
loJson.UpdateString("data[0].Availability[0].id","{{id of the subform record that does not need any update}}")
loJson.UpdateString("data[0].Availability[1].id","{{id of the subform record }}")
loJson.UpdateString("data[0].Availability[1].Weekdays","{{Weekdays}}")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PUT","https://domain.com/crm/v2/Leads",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "data": [
* {
* "code": "SUCCESS",
* "details": {
* "Modified_Time": "2021-05-11T13:20:33+00:00",
* "Modified_By": {
* "name": "Patricia Boyle",
* "id": "738964000000291009"
* },
* "Created_Time": "2021-05-07T06:38:15+00:00",
* "id": "738964000002130131",
* "Created_By": {
* "name": "Patricia Boyle",
* "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
lnCount_i = loJResp.SizeOfArray("data")
DO WHILE i < lnCount_i
loJResp.I = i
lcCode = loJResp.StringOf("data[i].code")
lcModified_Time = loJResp.StringOf("data[i].details.Modified_Time")
lcName = loJResp.StringOf("data[i].details.Modified_By.name")
lcId = loJResp.StringOf("data[i].details.Modified_By.id")
lcCreated_Time = loJResp.StringOf("data[i].details.Created_Time")
lcDetailsId = loJResp.StringOf("data[i].details.id")
lcCreated_ByName = loJResp.StringOf("data[i].details.Created_By.name")
lcCreated_ById = loJResp.StringOf("data[i].details.Created_By.id")
lcMessage = loJResp.StringOf("data[i].message")
lcStatus = loJResp.StringOf("data[i].status")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"data": [
{
"id": "{{record_id}}",
"Languages": [
{
"id": "{{id of the subform record that does not need any update}}"
},
{
"id": "{{id of the subform record}}",
"Proficiency": "{{data to be updated}}",
"Languages_Known": "{{data to be updated}}"
}
],
"Availability": [
{
"id": "{{id of the subform record that does not need any update}}"
},
{
"id": "{{id of the subform record }}",
"Weekdays": {{data to be updated}}
}
]
}
]
}'
https://domain.com/crm/v2/Leads
Postman Collection Item JSON
{
"name": "Update Subforms",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"{{record_id}}\",\n \"Languages\": [\n {\n \"id\": \"{{id of the subform record that does not need any update}}\"\n },\n {\n \"id\": \"{{id of the subform record}}\",\n \"Proficiency\": \"{{data to be updated}}\",\n \"Languages_Known\": \"{{data to be updated}}\"\n }\n ],\n \"Availability\": [\n {\n \"id\": \"{{id of the subform record that does not need any update}}\"\n },\n {\n \"id\": \"{{id of the subform record }}\",\n \"Weekdays\": {{data to be updated}}\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads"
]
},
"description": "To update a record with subforms in a module."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"738964000002130131\",\n \"Languages\": [\n {\n \"Proficiency\": \"Native\",\n \"Languages_Known\": \"English\"\n },\n {\n \"Proficiency\": \"Professional\",\n \"Languages_Known\": \"French\"\n }\n ],\n \"Availability\": [\n {\n \"Weekends\": false,\n \"Weekdays\": true\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 13:20:33 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "331"
},
{
"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"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"code\": \"SUCCESS\",\n \"details\": {\n \"Modified_Time\": \"2021-05-11T13:20:33+00:00\",\n \"Modified_By\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"738964000000291009\"\n },\n \"Created_Time\": \"2021-05-07T06:38:15+00:00\",\n \"id\": \"738964000002130131\",\n \"Created_By\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"738964000000291009\"\n }\n },\n \"message\": \"record updated\",\n \"status\": \"success\"\n }\n ]\n}"
},
{
"name": "INVALID_MODULE",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"738964000002130131\",\n \"Languages\": [\n {\n \"Proficiency\": \"Native\",\n \"Languages_Known\": \"English\"\n },\n {\n \"Proficiency\": \"Professional\",\n \"Languages_Known\": \"French\"\n }\n ],\n \"Availability\": [\n {\n \"Weekends\": false,\n \"Weekdays\": true\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/Lead",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Lead"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 13:20:51 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-11T13:58:39+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_REQUEST_METHOD",
"originalRequest": {
"method": "COPY",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"738964000002130131\",\n \"Languages\": [\n {\n \"Proficiency\": \"Native\",\n \"Languages_Known\": \"English\"\n },\n {\n \"Proficiency\": \"Professional\",\n \"Languages_Known\": \"French\"\n }\n ],\n \"Availability\": [\n {\n \"Weekends\": false,\n \"Weekdays\": true\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 13:21:02 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": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"738964000002130131\",\n \"Languages\": [\n {\n \"Proficiency\": \"Native\",\n \"Languages_Known\": \"English\"\n },\n {\n \"Proficiency\": \"Professional\",\n \"Languages_Known\": \"French\"\n }\n ],\n \"Availability\": [\n {\n \"Weekends\": false,\n \"Weekdays\": true\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 13:21:28 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": "MANDATORY_NOT_FOUND",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"Languages\": [\n {\n \"Proficiency\": \"Native\",\n \"Languages_Known\": \"English\"\n },\n {\n \"Proficiency\": \"Professional\",\n \"Languages_Known\": \"French\"\n }\n ],\n \"Availability\": [\n {\n \"Weekends\": false,\n \"Weekdays\": true\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 13:21:50 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "123"
},
{
"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\": \"MANDATORY_NOT_FOUND\",\n \"details\": {\n \"api_name\": \"id\"\n },\n \"message\": \"required field not found\",\n \"status\": \"error\"\n }\n ]\n}"
},
{
"name": "INVALID_DATA",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": 123\n \"Languages\": [\n {\n \"Proficiency\": \"Native\",\n \"Languages_Known\": \"English\"\n },\n {\n \"Proficiency\": \"Professional\",\n \"Languages_Known\": \"French\"\n }\n ],\n \"Availability\": [\n {\n \"Weekends\": false,\n \"Weekdays\": true\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 13:22:10 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "104"
},
{
"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": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_DATA\",\n \"details\": {\n \"expected_data_type\": \"jsonobject\"\n },\n \"message\": \"body\",\n \"status\": \"error\"\n}"
},
{
"name": "OAUTH_SCOPE_MISMATCH",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"{{record_id}}\",\n \"Languages\": [\n {\n \"id\": \"{{id of the subform record that does not need any update}}\"\n },\n {\n \"id\": \"{{id of the subform record}}\",\n \"Proficiency\": \"{{data to be updated}}\",\n \"Languages_Known\": \"{{data to be updated}}\"\n }\n ],\n \"Availability\": [\n {\n \"id\": \"{{id of the subform record that does not need any update}}\"\n },\n {\n \"id\": \"{{id of the subform record }}\",\n \"Weekdays\": {{data to be updated}}\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 06:36:03 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}"
}
]
}
