Chilkat Online Tools

VB6 / Support API / Update Custom Object

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")
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": {
'     "key": "<string>",
'     "title": "<string>",
'     "title_pluralized": "<string>",
'     "created_at": "<dateTime>",
'     "created_by_user_id": "<string>",
'     "description": "<string>",
'     "raw_description": "<string>",
'     "raw_title": "<string>",
'     "raw_title_pluralized": "<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 Key As String
Key = jResp.StringOf("custom_object.key")
Dim Title As String
Title = jResp.StringOf("custom_object.title")
Dim Title_pluralized As String
Title_pluralized = jResp.StringOf("custom_object.title_pluralized")
Dim Created_at As String
Created_at = jResp.StringOf("custom_object.created_at")
Dim Created_by_user_id As String
Created_by_user_id = jResp.StringOf("custom_object.created_by_user_id")
Dim Description As String
Description = jResp.StringOf("custom_object.description")
Dim Raw_description As String
Raw_description = jResp.StringOf("custom_object.raw_description")
Dim Raw_title As String
Raw_title = jResp.StringOf("custom_object.raw_title")
Dim Raw_title_pluralized As String
Raw_title_pluralized = jResp.StringOf("custom_object.raw_title_pluralized")
Dim Updated_at As String
Updated_at = jResp.StringOf("custom_object.updated_at")
Dim Updated_by_user_id As String
Updated_by_user_id = jResp.StringOf("custom_object.updated_by_user_id")
Dim v_Url As String
v_Url = jResp.StringOf("custom_object.url")

Curl Command

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

Postman Collection Item JSON

{
  "name": "Update Custom Object",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_objects",
        ":custom_object_key"
      ],
      "variable": [
        {
          "key": "custom_object_key",
          "value": "<string>"
        }
      ]
    },
    "description": "Updates an individual custom object. The updating rules are as follows:\n* Takes a `custom_object` object that specifies the properties to update\n* The `key` property cannot be updated\n#### Allowed For\n* Admins"
  },
  "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_objects",
            ":custom_object_key"
          ],
          "variable": [
            {
              "key": "custom_object_key"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"custom_object\": {\n    \"key\": \"<string>\",\n    \"title\": \"<string>\",\n    \"title_pluralized\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"created_by_user_id\": \"<string>\",\n    \"description\": \"<string>\",\n    \"raw_description\": \"<string>\",\n    \"raw_title\": \"<string>\",\n    \"raw_title_pluralized\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"updated_by_user_id\": \"<string>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}