Objective-C / Support API / Create Ticket 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: @"POST" url: @"https://example.zendesk.com/api/v2/ticket_fields"];
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)
// {
// "ticket_field": {
// "type": "<string>",
// "title": "<string>",
// "active": "<boolean>",
// "agent_description": "<string>",
// "collapsed_for_agents": "<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>"
// }
// ],
// "custom_statuses": [
// {
// "active": "<boolean>",
// "agent_label": "<string>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "end_user_description": "<string>",
// "end_user_label": "<string>",
// "id": "<integer>",
// "status_category": "solved",
// "updated_at": "<dateTime>"
// },
// {
// "active": "<boolean>",
// "agent_label": "<string>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "end_user_description": "<string>",
// "end_user_label": "<string>",
// "id": "<integer>",
// "status_category": "open",
// "updated_at": "<dateTime>"
// }
// ],
// "description": "<string>",
// "editable_in_portal": "<boolean>",
// "id": "<integer>",
// "position": "<integer>",
// "raw_description": "<string>",
// "raw_title": "<string>",
// "raw_title_in_portal": "<string>",
// "regexp_for_validation": "<string>",
// "relationship_filter": {},
// "relationship_target_type": "<string>",
// "removable": "<boolean>",
// "required": "<boolean>",
// "required_in_portal": "<boolean>",
// "sub_type_id": "<integer>",
// "system_field_options": [
// {
// "name": "<string>",
// "value": "<string>"
// },
// {
// "name": "<string>",
// "value": "<string>"
// }
// ],
// "tag": "<string>",
// "title_in_portal": "<string>",
// "updated_at": "<dateTime>",
// "url": "<string>",
// "visible_in_portal": "<boolean>"
// }
// }
// 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 *active = 0;
NSString *agent_label = 0;
NSString *created_at = 0;
NSString *default = 0;
NSString *description = 0;
NSString *end_user_description = 0;
NSString *end_user_label = 0;
NSString *status_category = 0;
NSString *updated_at = 0;
NSString *v_Type = [jResp StringOf: @"ticket_field.type"];
NSString *Title = [jResp StringOf: @"ticket_field.title"];
NSString *Active = [jResp StringOf: @"ticket_field.active"];
NSString *Agent_description = [jResp StringOf: @"ticket_field.agent_description"];
NSString *Collapsed_for_agents = [jResp StringOf: @"ticket_field.collapsed_for_agents"];
NSString *Created_at = [jResp StringOf: @"ticket_field.created_at"];
NSString *Description = [jResp StringOf: @"ticket_field.description"];
NSString *Editable_in_portal = [jResp StringOf: @"ticket_field.editable_in_portal"];
NSString *Id = [jResp StringOf: @"ticket_field.id"];
NSString *Position = [jResp StringOf: @"ticket_field.position"];
NSString *Raw_description = [jResp StringOf: @"ticket_field.raw_description"];
NSString *Raw_title = [jResp StringOf: @"ticket_field.raw_title"];
NSString *Raw_title_in_portal = [jResp StringOf: @"ticket_field.raw_title_in_portal"];
NSString *Regexp_for_validation = [jResp StringOf: @"ticket_field.regexp_for_validation"];
NSString *Relationship_target_type = [jResp StringOf: @"ticket_field.relationship_target_type"];
NSString *Removable = [jResp StringOf: @"ticket_field.removable"];
NSString *Required = [jResp StringOf: @"ticket_field.required"];
NSString *Required_in_portal = [jResp StringOf: @"ticket_field.required_in_portal"];
NSString *Sub_type_id = [jResp StringOf: @"ticket_field.sub_type_id"];
NSString *Tag = [jResp StringOf: @"ticket_field.tag"];
NSString *Title_in_portal = [jResp StringOf: @"ticket_field.title_in_portal"];
NSString *Updated_at = [jResp StringOf: @"ticket_field.updated_at"];
NSString *v_Url = [jResp StringOf: @"ticket_field.url"];
NSString *Visible_in_portal = [jResp StringOf: @"ticket_field.visible_in_portal"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"ticket_field.custom_field_options"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
name = [jResp StringOf: @"ticket_field.custom_field_options[i].name"];
value = [jResp StringOf: @"ticket_field.custom_field_options[i].value"];
id = [jResp StringOf: @"ticket_field.custom_field_options[i].id"];
position = [jResp StringOf: @"ticket_field.custom_field_options[i].position"];
raw_name = [jResp StringOf: @"ticket_field.custom_field_options[i].raw_name"];
url = [jResp StringOf: @"ticket_field.custom_field_options[i].url"];
i = i + 1;
}
i = 0;
count_i = [[jResp SizeOfArray: @"ticket_field.custom_statuses"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
active = [jResp StringOf: @"ticket_field.custom_statuses[i].active"];
agent_label = [jResp StringOf: @"ticket_field.custom_statuses[i].agent_label"];
created_at = [jResp StringOf: @"ticket_field.custom_statuses[i].created_at"];
default = [jResp StringOf: @"ticket_field.custom_statuses[i].default"];
description = [jResp StringOf: @"ticket_field.custom_statuses[i].description"];
end_user_description = [jResp StringOf: @"ticket_field.custom_statuses[i].end_user_description"];
end_user_label = [jResp StringOf: @"ticket_field.custom_statuses[i].end_user_label"];
id = [jResp StringOf: @"ticket_field.custom_statuses[i].id"];
status_category = [jResp StringOf: @"ticket_field.custom_statuses[i].status_category"];
updated_at = [jResp StringOf: @"ticket_field.custom_statuses[i].updated_at"];
i = i + 1;
}
i = 0;
count_i = [[jResp SizeOfArray: @"ticket_field.system_field_options"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
name = [jResp StringOf: @"ticket_field.system_field_options[i].name"];
value = [jResp StringOf: @"ticket_field.system_field_options[i].value"];
i = i + 1;
}
Curl Command
curl -u login:password -X POST
-H "Accept: application/json"
https://example.zendesk.com/api/v2/ticket_fields
Postman Collection Item JSON
{
"name": "Create Ticket Field",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ticket_fields",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ticket_fields"
]
},
"description": "Creates any of the following custom field types:\n\n| Custom field type | Description |\n|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| text | Default custom field type when `type` is not specified |\n| textarea | For multi-line text |\n| checkbox | To capture a boolean value. Allowed values are true or false |\n| date | Example: 2021-04-16 |\n| integer | String composed of numbers. May contain an optional decimal point |\n| decimal | For numbers containing decimals |\n| regexp | Matches the Regex pattern found in the custom field settings |\n| partialcreditcard | A credit card number. Only the last 4 digits are retained |\n| multiselect | Enables users to choose multiple options from a dropdown menu |\n| tagger | Single-select dropdown menu. It contains one or more tag values belonging to the field's options. Example: ( {\"id\": 21938362, \"value\": [\"hd_3000\", \"hd_5555\"]}) |\n| lookup | A field to create a relationship (see [lookup relationships](/api-reference/ticketing/lookup_relationships/lookup_relationships/)) to another object such as a user, ticket, or organization |\n\nSee [About custom field types](https://support.zendesk.com/hc/en-us/articles/203661866) in the Zendesk Help Center.\n\n#### Allowed For\n\n* Admins\n\n#### Field limits\n\nWe recommend the following best practices for ticket fields limits. Creating more than these amounts can affect performance.\n\n* 400 ticket fields per account if your account doesn't have ticket forms\n* 400 ticket fields per ticket form if your account has ticket forms\n"
},
"response": [
{
"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/ticket_fields",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ticket_fields"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"ticket_field\": {\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"agent_description\": \"<string>\",\n \"collapsed_for_agents\": \"<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 \"custom_statuses\": [\n {\n \"active\": \"<boolean>\",\n \"agent_label\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"end_user_description\": \"<string>\",\n \"end_user_label\": \"<string>\",\n \"id\": \"<integer>\",\n \"status_category\": \"solved\",\n \"updated_at\": \"<dateTime>\"\n },\n {\n \"active\": \"<boolean>\",\n \"agent_label\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"end_user_description\": \"<string>\",\n \"end_user_label\": \"<string>\",\n \"id\": \"<integer>\",\n \"status_category\": \"open\",\n \"updated_at\": \"<dateTime>\"\n }\n ],\n \"description\": \"<string>\",\n \"editable_in_portal\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_description\": \"<string>\",\n \"raw_title\": \"<string>\",\n \"raw_title_in_portal\": \"<string>\",\n \"regexp_for_validation\": \"<string>\",\n \"relationship_filter\": {},\n \"relationship_target_type\": \"<string>\",\n \"removable\": \"<boolean>\",\n \"required\": \"<boolean>\",\n \"required_in_portal\": \"<boolean>\",\n \"sub_type_id\": \"<integer>\",\n \"system_field_options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"tag\": \"<string>\",\n \"title_in_portal\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"visible_in_portal\": \"<boolean>\"\n }\n}"
}
]
}
