Chilkat Online Tools

Objective-C / Support API / Update User Field

Back to Collection Items

#import <CkoHttp.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

http.BasicAuth = YES;
http.Login = @"login";
http.Password = @"password";

[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoHttpResponse *resp = [http QuickRequest: @"PUT" url: @"https://example.zendesk.com/api/v2/user_fields/:user_field_id"];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

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

// {
//   "user_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

NSString *name = 0;
NSString *value = 0;
NSString *id = 0;
NSString *position = 0;
NSString *raw_name = 0;
NSString *url = 0;

NSString *Key = [jResp StringOf: @"user_field.key"];
NSString *v_Type = [jResp StringOf: @"user_field.type"];
NSString *Title = [jResp StringOf: @"user_field.title"];
NSString *Active = [jResp StringOf: @"user_field.active"];
NSString *Created_at = [jResp StringOf: @"user_field.created_at"];
NSString *Description = [jResp StringOf: @"user_field.description"];
NSString *Id = [jResp StringOf: @"user_field.id"];
NSString *Position = [jResp StringOf: @"user_field.position"];
NSString *Raw_description = [jResp StringOf: @"user_field.raw_description"];
NSString *Raw_title = [jResp StringOf: @"user_field.raw_title"];
NSString *Regexp_for_validation = [jResp StringOf: @"user_field.regexp_for_validation"];
NSString *Relationship_target_type = [jResp StringOf: @"user_field.relationship_target_type"];
NSString *System = [jResp StringOf: @"user_field.system"];
NSString *Tag = [jResp StringOf: @"user_field.tag"];
NSString *Updated_at = [jResp StringOf: @"user_field.updated_at"];
NSString *v_Url = [jResp StringOf: @"user_field.url"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"user_field.custom_field_options"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    name = [jResp StringOf: @"user_field.custom_field_options[i].name"];
    value = [jResp StringOf: @"user_field.custom_field_options[i].value"];
    id = [jResp StringOf: @"user_field.custom_field_options[i].id"];
    position = [jResp StringOf: @"user_field.custom_field_options[i].position"];
    raw_name = [jResp StringOf: @"user_field.custom_field_options[i].raw_name"];
    url = [jResp StringOf: @"user_field.custom_field_options[i].url"];
    i = i + 1;
}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Update User Field",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/user_fields/:user_field_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "user_fields",
        ":user_field_id"
      ],
      "variable": [
        {
          "key": "user_field_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Updating a Dropdown (Tagger) Field\n\nDropdown fields return an array of `custom_field_options` which specify the name, value and order of the list of dropdown options.\nUnderstand the following behavior when updating a dropdown field:\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 `name` and `value`.\n- To update an existing option, pass its `id` along with `name` and `value`.\n- To re-order 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/user_fields/{user_field_id}.json \\\n  -H \"Content-Type: application/json\" -X PUT \\\n  -d '{\"user_field\": {\"custom_field_options\": [{\"id\": 124, \"name\": \"Option 2\", \"value\": \"option_2\"}, {\"id\": 123, \"name\": \"Option 1\", \"value\": \"option_1\"}, {\"id\": 125, \"name\": \"Option 2\", \"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/user_fields/:user_field_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "user_fields",
            ":user_field_id"
          ],
          "variable": [
            {
              "key": "user_field_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"user_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}"
    }
  ]
}