Chilkat Online Tools

VB6 / Support API / Update Custom Object Record

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 ChilkatHttp
Dim success As Long

http.BasicAuth = 1
http.Login = "login"
http.Password = "password"

http.SetRequestHeader "Accept","application/json"

Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequest("PATCH","https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id")
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "custom_object_record": {
'     "name": "<string>",
'     "created_at": "<dateTime>",
'     "created_by_user_id": "<string>",
'     "custom_object_fields": {
'       "do8": "<string>",
'       "adipisicing_e": "<string>",
'       "commodo0": "<string>",
'       "sunta4": "<string>"
'     },
'     "custom_object_key": "<string>",
'     "external_id": "<string>",
'     "id": "<string>",
'     "updated_at": "<dateTime>",
'     "updated_by_user_id": "<string>",
'     "url": "<string>"
'   }
' }

' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Dim Name As String
Name = jResp.StringOf("custom_object_record.name")
Dim Created_at As String
Created_at = jResp.StringOf("custom_object_record.created_at")
Dim Created_by_user_id As String
Created_by_user_id = jResp.StringOf("custom_object_record.created_by_user_id")
Dim Do8 As String
Do8 = jResp.StringOf("custom_object_record.custom_object_fields.do8")
Dim Adipisicing_e As String
Adipisicing_e = jResp.StringOf("custom_object_record.custom_object_fields.adipisicing_e")
Dim Commodo0 As String
Commodo0 = jResp.StringOf("custom_object_record.custom_object_fields.commodo0")
Dim Sunta4 As String
Sunta4 = jResp.StringOf("custom_object_record.custom_object_fields.sunta4")
Dim Custom_object_key As String
Custom_object_key = jResp.StringOf("custom_object_record.custom_object_key")
Dim External_id As String
External_id = jResp.StringOf("custom_object_record.external_id")
Dim Id As String
Id = jResp.StringOf("custom_object_record.id")
Dim Updated_at As String
Updated_at = jResp.StringOf("custom_object_record.updated_at")
Dim Updated_by_user_id As String
Updated_by_user_id = jResp.StringOf("custom_object_record.updated_by_user_id")
Dim v_Url As String
v_Url = jResp.StringOf("custom_object_record.url")

Curl Command

curl  -u login:password -X PATCH
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id

Postman Collection Item JSON

{
  "name": "Update Custom Object Record",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_objects",
        ":custom_object_key",
        "records",
        ":custom_object_record_id"
      ],
      "variable": [
        {
          "key": "custom_object_key",
          "value": "<string>"
        },
        {
          "key": "custom_object_record_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Updates an individual custom object record. The updating rules are as follows:\n* Takes a `custom_object_record` object that specifies the properties to update\n* The custom object fields should be nested inside a `custom_object_fields` object\n#### Allowed For\n* Agents"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_objects",
            ":custom_object_key",
            "records",
            ":custom_object_record_id"
          ],
          "variable": [
            {
              "key": "custom_object_key"
            },
            {
              "key": "custom_object_record_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"custom_object_record\": {\n    \"name\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"created_by_user_id\": \"<string>\",\n    \"custom_object_fields\": {\n      \"do8\": \"<string>\",\n      \"adipisicing_e\": \"<string>\",\n      \"commodo0\": \"<string>\",\n      \"sunta4\": \"<string>\"\n    },\n    \"custom_object_key\": \"<string>\",\n    \"external_id\": \"<string>\",\n    \"id\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"updated_by_user_id\": \"<string>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}