Chilkat Online Tools

C / Support API / Update Organization Field

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *name;
    const char *value;
    const char *id;
    const char *position;
    const char *raw_name;
    const char *url;
    const char *Key;
    const char *v_Type;
    const char *Title;
    const char *Active;
    const char *Created_at;
    const char *Description;
    const char *Id;
    const char *Position;
    const char *Raw_description;
    const char *Raw_title;
    const char *Regexp_for_validation;
    const char *Relationship_target_type;
    const char *System;
    const char *Tag;
    const char *Updated_at;
    const char *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 = CkHttp_Create();

    CkHttp_putBasicAuth(http,TRUE);
    CkHttp_putLogin(http,"login");
    CkHttp_putPassword(http,"password");

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

    resp = CkHttp_QuickRequest(http,"PUT","https://example.zendesk.com/api/v2/organization_fields/:organization_field_id");
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        return;
    }

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

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttpResponse_getStatusCode(resp);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttpResponse_header(resp));
        printf("Failed.\n");
        CkHttpResponse_Dispose(resp);
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    CkHttpResponse_Dispose(resp);

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

    // {
    //   "organization_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 = CkJsonObject_stringOf(jResp,"organization_field.key");
    v_Type = CkJsonObject_stringOf(jResp,"organization_field.type");
    Title = CkJsonObject_stringOf(jResp,"organization_field.title");
    Active = CkJsonObject_stringOf(jResp,"organization_field.active");
    Created_at = CkJsonObject_stringOf(jResp,"organization_field.created_at");
    Description = CkJsonObject_stringOf(jResp,"organization_field.description");
    Id = CkJsonObject_stringOf(jResp,"organization_field.id");
    Position = CkJsonObject_stringOf(jResp,"organization_field.position");
    Raw_description = CkJsonObject_stringOf(jResp,"organization_field.raw_description");
    Raw_title = CkJsonObject_stringOf(jResp,"organization_field.raw_title");
    Regexp_for_validation = CkJsonObject_stringOf(jResp,"organization_field.regexp_for_validation");
    Relationship_target_type = CkJsonObject_stringOf(jResp,"organization_field.relationship_target_type");
    System = CkJsonObject_stringOf(jResp,"organization_field.system");
    Tag = CkJsonObject_stringOf(jResp,"organization_field.tag");
    Updated_at = CkJsonObject_stringOf(jResp,"organization_field.updated_at");
    v_Url = CkJsonObject_stringOf(jResp,"organization_field.url");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"organization_field.custom_field_options");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        name = CkJsonObject_stringOf(jResp,"organization_field.custom_field_options[i].name");
        value = CkJsonObject_stringOf(jResp,"organization_field.custom_field_options[i].value");
        id = CkJsonObject_stringOf(jResp,"organization_field.custom_field_options[i].id");
        position = CkJsonObject_stringOf(jResp,"organization_field.custom_field_options[i].position");
        raw_name = CkJsonObject_stringOf(jResp,"organization_field.custom_field_options[i].raw_name");
        url = CkJsonObject_stringOf(jResp,"organization_field.custom_field_options[i].url");
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

Curl Command

curl  -u login:password -X PUT
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/organization_fields/:organization_field_id

Postman Collection Item JSON

{
  "name": "Update Organization Field",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/organization_fields/:organization_field_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "organization_fields",
        ":organization_field_id"
      ],
      "variable": [
        {
          "key": "organization_field_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Updating a Drop-down (Tagger) Field\n\nDrop-down fields return an array of `custom_field_options` which specify the name, value, and order of drop-down options. When updating a drop-down field, note the following information:\n\n- All options must be passed on update. Options that are not passed will be removed. As a result, these values will be removed from any organizations\n- To create a new option, pass a null `id` along with the `name` and `value`\n- To update an existing option, pass its `id` along with the `name` and `value`\n- To reorder an option, reposition it in the `custom_field_options` array relative to the other options\n- To remove an option, omit it from the list of options upon update\n\n#### Example Request\n\n```bash\ncurl https://{subdomain}.zendesk.com/api/v2/organization_fields/{organization_field_id}.json \\\n  -H \"Content-Type: application/json\" -X PUT \\\n  -d '{\"organization_field\": {\"custom_field_options\": [{\"id\": 124, \"name\": \"Option 2\", \"value\": \"option_2\"}, {\"id\": 123, \"name\": \"Option 1\", \"value\": \"option_1\"}, {\"id\": 125, \"name\": \"Option 3\", \"value\": \"option_3\"}]}}' \\\n  -v -u {email_address}:{password}\n```\n#### Allowed for\n\n* Admins\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/organization_fields/:organization_field_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organization_fields",
            ":organization_field_id"
          ],
          "variable": [
            {
              "key": "organization_field_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"organization_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}"
    }
  ]
}