Chilkat Online Tools

unicodeC / Support API / Update Custom Object Field

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkHttpResponseW resp;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *name;
    const wchar_t *value;
    const wchar_t *id;
    const wchar_t *position;
    const wchar_t *raw_name;
    const wchar_t *url;
    const wchar_t *Key;
    const wchar_t *v_Type;
    const wchar_t *Title;
    const wchar_t *Active;
    const wchar_t *Created_at;
    const wchar_t *Description;
    const wchar_t *Id;
    const wchar_t *Position;
    const wchar_t *Raw_description;
    const wchar_t *Raw_title;
    const wchar_t *Regexp_for_validation;
    const wchar_t *Relationship_target_type;
    const wchar_t *System;
    const wchar_t *Tag;
    const wchar_t *Updated_at;
    const wchar_t *v_Url;
    int i;
    int count_i;

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

    http = CkHttpW_Create();

    CkHttpW_putBasicAuth(http,TRUE);
    CkHttpW_putLogin(http,L"login");
    CkHttpW_putPassword(http,L"password");

    CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");

    resp = CkHttpW_QuickRequest(http,L"PATCH",L"https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields/:custom_object_field_key_or_id");
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        return;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpResponseW_getStatusCode(resp);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpResponseW_header(resp));
        wprintf(L"Failed.\n");
        CkHttpResponseW_Dispose(resp);
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    CkHttpResponseW_Dispose(resp);

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "custom_object_field": {
    //     "key": "<string>",
    //     "type": "<string>",
    //     "title": "<string>",
    //     "active": "<boolean>",
    //     "created_at": "<dateTime>",
    //     "custom_field_options": [
    //       {
    //         "name": "<string>",
    //         "value": "<string>",
    //         "id": "<integer>",
    //         "position": "<integer>",
    //         "raw_name": "<string>",
    //         "url": "<string>"
    //       },
    //       {
    //         "name": "<string>",
    //         "value": "<string>",
    //         "id": "<integer>",
    //         "position": "<integer>",
    //         "raw_name": "<string>",
    //         "url": "<string>"
    //       }
    //     ],
    //     "description": "<string>",
    //     "id": "<integer>",
    //     "position": "<integer>",
    //     "raw_description": "<string>",
    //     "raw_title": "<string>",
    //     "regexp_for_validation": "<string>",
    //     "relationship_filter": {},
    //     "relationship_target_type": "<string>",
    //     "system": "<boolean>",
    //     "tag": "<string>",
    //     "updated_at": "<dateTime>",
    //     "url": "<string>"
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    Key = CkJsonObjectW_stringOf(jResp,L"custom_object_field.key");
    v_Type = CkJsonObjectW_stringOf(jResp,L"custom_object_field.type");
    Title = CkJsonObjectW_stringOf(jResp,L"custom_object_field.title");
    Active = CkJsonObjectW_stringOf(jResp,L"custom_object_field.active");
    Created_at = CkJsonObjectW_stringOf(jResp,L"custom_object_field.created_at");
    Description = CkJsonObjectW_stringOf(jResp,L"custom_object_field.description");
    Id = CkJsonObjectW_stringOf(jResp,L"custom_object_field.id");
    Position = CkJsonObjectW_stringOf(jResp,L"custom_object_field.position");
    Raw_description = CkJsonObjectW_stringOf(jResp,L"custom_object_field.raw_description");
    Raw_title = CkJsonObjectW_stringOf(jResp,L"custom_object_field.raw_title");
    Regexp_for_validation = CkJsonObjectW_stringOf(jResp,L"custom_object_field.regexp_for_validation");
    Relationship_target_type = CkJsonObjectW_stringOf(jResp,L"custom_object_field.relationship_target_type");
    System = CkJsonObjectW_stringOf(jResp,L"custom_object_field.system");
    Tag = CkJsonObjectW_stringOf(jResp,L"custom_object_field.tag");
    Updated_at = CkJsonObjectW_stringOf(jResp,L"custom_object_field.updated_at");
    v_Url = CkJsonObjectW_stringOf(jResp,L"custom_object_field.url");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"custom_object_field.custom_field_options");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        name = CkJsonObjectW_stringOf(jResp,L"custom_object_field.custom_field_options[i].name");
        value = CkJsonObjectW_stringOf(jResp,L"custom_object_field.custom_field_options[i].value");
        id = CkJsonObjectW_stringOf(jResp,L"custom_object_field.custom_field_options[i].id");
        position = CkJsonObjectW_stringOf(jResp,L"custom_object_field.custom_field_options[i].position");
        raw_name = CkJsonObjectW_stringOf(jResp,L"custom_object_field.custom_field_options[i].raw_name");
        url = CkJsonObjectW_stringOf(jResp,L"custom_object_field.custom_field_options[i].url");
        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_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/fields/:custom_object_field_key_or_id

Postman Collection Item JSON

{
  "name": "Update Custom Object Field",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields/:custom_object_field_key_or_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_objects",
        ":custom_object_key",
        "fields",
        ":custom_object_field_key_or_id"
      ],
      "variable": [
        {
          "key": "custom_object_key",
          "value": "<string>"
        },
        {
          "key": "custom_object_field_key_or_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Updates individual custom object fields. The updating rules are as follows:\n* Takes a `custom_object_field` 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/fields/:custom_object_field_key_or_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_objects",
            ":custom_object_key",
            "fields",
            ":custom_object_field_key_or_id"
          ],
          "variable": [
            {
              "key": "custom_object_key"
            },
            {
              "key": "custom_object_field_key_or_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"custom_object_field\": {\n    \"key\": \"<string>\",\n    \"type\": \"<string>\",\n    \"title\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"created_at\": \"<dateTime>\",\n    \"custom_field_options\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"position\": \"<integer>\",\n        \"raw_name\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"position\": \"<integer>\",\n        \"raw_name\": \"<string>\",\n        \"url\": \"<string>\"\n      }\n    ],\n    \"description\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"position\": \"<integer>\",\n    \"raw_description\": \"<string>\",\n    \"raw_title\": \"<string>\",\n    \"regexp_for_validation\": \"<string>\",\n    \"relationship_filter\": {},\n    \"relationship_target_type\": \"<string>\",\n    \"system\": \"<boolean>\",\n    \"tag\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}