TCL / Support API / Update Custom Object
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequest $http "PATCH" "https://example.zendesk.com/api/v2/custom_objects/:custom_object_key"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set Key [CkJsonObject_stringOf $jResp "custom_object.key"]
set Title [CkJsonObject_stringOf $jResp "custom_object.title"]
set Title_pluralized [CkJsonObject_stringOf $jResp "custom_object.title_pluralized"]
set Created_at [CkJsonObject_stringOf $jResp "custom_object.created_at"]
set Created_by_user_id [CkJsonObject_stringOf $jResp "custom_object.created_by_user_id"]
set Description [CkJsonObject_stringOf $jResp "custom_object.description"]
set Raw_description [CkJsonObject_stringOf $jResp "custom_object.raw_description"]
set Raw_title [CkJsonObject_stringOf $jResp "custom_object.raw_title"]
set Raw_title_pluralized [CkJsonObject_stringOf $jResp "custom_object.raw_title_pluralized"]
set Updated_at [CkJsonObject_stringOf $jResp "custom_object.updated_at"]
set Updated_by_user_id [CkJsonObject_stringOf $jResp "custom_object.updated_by_user_id"]
set v_Url [CkJsonObject_stringOf $jResp "custom_object.url"]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}