Chilkat Online Tools

lianja / 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.

loHttp = createobject("CkHttp")

loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.Password = "password"

loHttp.SetRequestHeader("Accept","application/json")

loResp = loHttp.QuickRequest("PATCH","https://example.zendesk.com/api/v2/custom_objects/:custom_object_key")
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

// 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

lcKey = loJResp.StringOf("custom_object.key")
lcTitle = loJResp.StringOf("custom_object.title")
lcTitle_pluralized = loJResp.StringOf("custom_object.title_pluralized")
lcCreated_at = loJResp.StringOf("custom_object.created_at")
lcCreated_by_user_id = loJResp.StringOf("custom_object.created_by_user_id")
lcDescription = loJResp.StringOf("custom_object.description")
lcRaw_description = loJResp.StringOf("custom_object.raw_description")
lcRaw_title = loJResp.StringOf("custom_object.raw_title")
lcRaw_title_pluralized = loJResp.StringOf("custom_object.raw_title_pluralized")
lcUpdated_at = loJResp.StringOf("custom_object.updated_at")
lcUpdated_by_user_id = loJResp.StringOf("custom_object.updated_by_user_id")
lcV_Url = loJResp.StringOf("custom_object.url")


release loHttp
release loSbResponseBody
release loJResp

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}"
    }
  ]
}