Chilkat Online Tools

delphiDll / Support API / Update Custom Object

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Key: PWideChar;
Title: PWideChar;
Title_pluralized: PWideChar;
Created_at: PWideChar;
Created_by_user_id: PWideChar;
Description: PWideChar;
Raw_description: PWideChar;
Raw_title: PWideChar;
Raw_title_pluralized: PWideChar;
Updated_at: PWideChar;
Updated_by_user_id: PWideChar;
v_Url: PWideChar;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := CkHttp_Create();

CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'login');
CkHttp_putPassword(http,'password');

CkHttp_SetRequestHeader(http,'Accept','application/json');

resp := CkHttp_QuickRequest(http,'PATCH','https://example.zendesk.com/api/v2/custom_objects/:custom_object_key');
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(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

Key := CkJsonObject__stringOf(jResp,'custom_object.key');
Title := CkJsonObject__stringOf(jResp,'custom_object.title');
Title_pluralized := CkJsonObject__stringOf(jResp,'custom_object.title_pluralized');
Created_at := CkJsonObject__stringOf(jResp,'custom_object.created_at');
Created_by_user_id := CkJsonObject__stringOf(jResp,'custom_object.created_by_user_id');
Description := CkJsonObject__stringOf(jResp,'custom_object.description');
Raw_description := CkJsonObject__stringOf(jResp,'custom_object.raw_description');
Raw_title := CkJsonObject__stringOf(jResp,'custom_object.raw_title');
Raw_title_pluralized := CkJsonObject__stringOf(jResp,'custom_object.raw_title_pluralized');
Updated_at := CkJsonObject__stringOf(jResp,'custom_object.updated_at');
Updated_by_user_id := CkJsonObject__stringOf(jResp,'custom_object.updated_by_user_id');
v_Url := CkJsonObject__stringOf(jResp,'custom_object.url');

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(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}"
    }
  ]
}