Classic ASP / Support API / Update Custom Object
Back to Collection Items
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
' 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")
set http = Server.CreateObject("Chilkat.Http")
http.BasicAuth = 1
http.Login = "login"
http.Password = "password"
http.SetRequestHeader "Accept","application/json"
' resp is a Chilkat.HttpResponse
Set resp = http.QuickRequest("PATCH","https://example.zendesk.com/api/v2/custom_objects/:custom_object_key")
If (http.LastMethodSuccess = 0) Then
Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
Response.End
End If
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = Server.CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = Server.CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Response.Write "<pre>" & Server.HTMLEncode( "Response Body:") & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( jResp.Emit()) & "</pre>"
respStatusCode = resp.StatusCode
Response.Write "<pre>" & Server.HTMLEncode( "Response Status Code = " & respStatusCode) & "</pre>"
If (respStatusCode >= 400) Then
Response.Write "<pre>" & Server.HTMLEncode( "Response Header:") & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( resp.Header) & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( "Failed.") & "</pre>"
Response.End
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
Key = jResp.StringOf("custom_object.key")
Title = jResp.StringOf("custom_object.title")
Title_pluralized = jResp.StringOf("custom_object.title_pluralized")
Created_at = jResp.StringOf("custom_object.created_at")
Created_by_user_id = jResp.StringOf("custom_object.created_by_user_id")
Description = jResp.StringOf("custom_object.description")
Raw_description = jResp.StringOf("custom_object.raw_description")
Raw_title = jResp.StringOf("custom_object.raw_title")
Raw_title_pluralized = jResp.StringOf("custom_object.raw_title_pluralized")
Updated_at = jResp.StringOf("custom_object.updated_at")
Updated_by_user_id = jResp.StringOf("custom_object.updated_by_user_id")
v_Url = jResp.StringOf("custom_object.url")
%>
</body>
</html>
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}"
}
]
}
