Chilkat Online Tools

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

Local $oResp = $oHttp.QuickRequest("PATCH","https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id")
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $sName = $oJResp.StringOf("custom_object_record.name")
Local $sCreated_at = $oJResp.StringOf("custom_object_record.created_at")
Local $sCreated_by_user_id = $oJResp.StringOf("custom_object_record.created_by_user_id")
Local $sDo8 = $oJResp.StringOf("custom_object_record.custom_object_fields.do8")
Local $sAdipisicing_e = $oJResp.StringOf("custom_object_record.custom_object_fields.adipisicing_e")
Local $sCommodo0 = $oJResp.StringOf("custom_object_record.custom_object_fields.commodo0")
Local $sSunta4 = $oJResp.StringOf("custom_object_record.custom_object_fields.sunta4")
Local $sCustom_object_key = $oJResp.StringOf("custom_object_record.custom_object_key")
Local $sExternal_id = $oJResp.StringOf("custom_object_record.external_id")
Local $sId = $oJResp.StringOf("custom_object_record.id")
Local $sUpdated_at = $oJResp.StringOf("custom_object_record.updated_at")
Local $sUpdated_by_user_id = $oJResp.StringOf("custom_object_record.updated_by_user_id")
Local $sV_Url = $oJResp.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}"
    }
  ]
}