Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
' 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}}"
' }
' ]
' }
' ]
' }
Dim json As New Chilkat.JsonObject
json.UpdateString("data[0].id","{{record_id}}")
json.UpdateString("data[0].Languages[0].id","{{id of the subform record that does not need any update}}")
json.UpdateString("data[0].Languages[1].id","{{id of the subform record}}")
json.UpdateString("data[0].Languages[1].Proficiency","{{data to be updated}}")
json.UpdateString("data[0].Languages[1].Languages_Known","{{data to be updated}}")
json.UpdateString("data[0].Availability[0].id","{{id of the subform record that does not need any update}}")
json.UpdateString("data[0].Availability[1].id","{{id of the subform record }}")
json.UpdateString("data[0].Availability[1].Weekdays","{{Weekdays}}")
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
Dim sbRequestBody As New Chilkat.StringBuilder
json.EmitSb(sbRequestBody)
Dim resp As Chilkat.HttpResponse = http.PTextSb("PUT","https://domain.com/crm/v2.1/Leads",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "data": [
' {
' "code": "SUCCESS",
' "details": {
' "Modified_Time": "2021-05-07T06:41:05+00:00",
' "Modified_By": {
' "name": "Patricia",
' "id": "738964000000291009"
' },
' "Created_Time": "2021-05-07T06:38:15+00:00",
' "id": "738964000002130131",
' "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
Dim code As String
Dim Modified_Time As String
Dim Name As String
Dim Id As String
Dim Created_Time As String
Dim detailsId As String
Dim Created_ByName As String
Dim Created_ById As String
Dim message As String
Dim status As String
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("data")
While i < count_i
jResp.I = i
code = jResp.StringOf("data[i].code")
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
End While
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.1/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.1/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"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.1/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 06:41:06 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "325"
},
{
"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-07T06:44:53+00:00"
},
{
"key": "clientVersion",
"value": "4016256"
},
{
"key": "clientsubVersion",
"value": "8ef7aa3133ce0e105307c407d89b23d9"
},
{
"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-07T06:41:05+00:00\",\n \"Modified_By\": {\n \"name\": \"Patricia\",\n \"id\": \"738964000000291009\"\n },\n \"Created_Time\": \"2021-05-07T06:38:15+00:00\",\n \"id\": \"738964000002130131\",\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": "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.1/Lead",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Lead"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 06:42:48 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-07T06:44:53+00:00"
},
{
"key": "clientVersion",
"value": "4016256"
},
{
"key": "clientsubVersion",
"value": "8ef7aa3133ce0e105307c407d89b23d9"
},
{
"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_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.1/Lead",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Lead"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 06:43:04 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.1/Lead",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Lead"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 06:43:23 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 \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.1/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 06:43:45 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "150"
},
{
"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-07T06:44:53+00:00"
},
{
"key": "clientVersion",
"value": "4016256"
},
{
"key": "clientsubVersion",
"value": "8ef7aa3133ce0e105307c407d89b23d9"
},
{
"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 \"json_path\": \"$.data[0].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\": test,\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.1/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 06:44:19 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "159"
},
{
"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-07T06:44:53+00:00"
},
{
"key": "clientVersion",
"value": "4016256"
},
{
"key": "clientsubVersion",
"value": "8ef7aa3133ce0e105307c407d89b23d9"
},
{
"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\": \"long\",\n \"api_name\": \"id\",\n \"json_path\": \"$.data[0].id\"\n },\n \"message\": \"invalid data\",\n \"status\": \"error\"\n }\n ]\n}"
},
{
"name": "INVALID_REQUEST",
"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.1/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 06:52:31 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "192"
},
{
"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\": \"INVALID_REQUEST\",\n \"details\": {},\n \"message\": \"unable to process your request. please verify whether you have entered proper method name, parameter and parameter values.\",\n \"status\": \"error\"\n}"
}
]
}
