Chilkat Online Tools

Java / Support API / Create or Update a User Field Option

Back to Collection Items

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean success;

    http.put_BasicAuth(true);
    http.put_Login("login");
    http.put_Password("password");

    http.SetRequestHeader("Accept","application/json");

    CkHttpResponse resp = http.QuickRequest("POST","https://example.zendesk.com/api/v2/user_fields/:user_field_id/options");
    if (http.get_LastMethodSuccess() == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    System.out.println("Response Body:");
    System.out.println(jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(resp.header());
        System.out.println("Failed.");

        return;
        }

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

    // {
    //   "custom_field_option": {
    //     "name": "<string>",
    //     "value": "<string>",
    //     "id": "<integer>",
    //     "position": "<integer>",
    //     "raw_name": "<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

    String Name = jResp.stringOf("custom_field_option.name");
    String Value = jResp.stringOf("custom_field_option.value");
    String Id = jResp.stringOf("custom_field_option.id");
    String Position = jResp.stringOf("custom_field_option.position");
    String Raw_name = jResp.stringOf("custom_field_option.raw_name");
    String v_Url = jResp.stringOf("custom_field_option.url");
  }
}

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/user_fields/:user_field_id/options

Postman Collection Item JSON

{
  "name": "Create or Update a User Field Option",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/user_fields/:user_field_id/options",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "user_fields",
        ":user_field_id",
        "options"
      ],
      "variable": [
        {
          "key": "user_field_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Creates a new option or updates an existing option for the given drop-down user field.\n\nTo update an option, include the id of the option in the `custom_field_option` object. Example: `{\"custom_field_option\": {\"id\": 10002, \"name\": \"Pineapples\", ... }`. If an option exists for the given ID, the option will be updated. Otherwise, a new option will be created.\n\n#### Response\n\nReturns one of the following status codes:\n\n- 200 with `Location: /api/v2/user_fields/{user_field_id}/options.json` if the user field option already exists in the database\n- 201 with `Location: /api/v2/user_fields/{user_field_id}/options.json` if the user field option is new\n\n#### Allowed For\n\n* Admins\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/user_fields/:user_field_id/options",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "user_fields",
            ":user_field_id",
            "options"
          ],
          "variable": [
            {
              "key": "user_field_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"custom_field_option\": {\n    \"name\": \"<string>\",\n    \"value\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"position\": \"<integer>\",\n    \"raw_name\": \"<string>\",\n    \"url\": \"<string>\"\n  }\n}"
    },
    {
      "name": "Created response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/user_fields/:user_field_id/options",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "user_fields",
            ":user_field_id",
            "options"
          ],
          "variable": [
            {
              "key": "user_field_id"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"custom_field_option\": {\n    \"name\": \"<string>\",\n    \"value\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"position\": \"<integer>\",\n    \"raw_name\": \"<string>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}