TCL / Support API / Create Ticket Field
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequest $http "POST" "https://example.zendesk.com/api/v2/ticket_fields"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set v_Type [CkJsonObject_stringOf $jResp "ticket_field.type"]
set Title [CkJsonObject_stringOf $jResp "ticket_field.title"]
set Active [CkJsonObject_stringOf $jResp "ticket_field.active"]
set Agent_description [CkJsonObject_stringOf $jResp "ticket_field.agent_description"]
set Collapsed_for_agents [CkJsonObject_stringOf $jResp "ticket_field.collapsed_for_agents"]
set Created_at [CkJsonObject_stringOf $jResp "ticket_field.created_at"]
set Description [CkJsonObject_stringOf $jResp "ticket_field.description"]
set Editable_in_portal [CkJsonObject_stringOf $jResp "ticket_field.editable_in_portal"]
set Id [CkJsonObject_stringOf $jResp "ticket_field.id"]
set Position [CkJsonObject_stringOf $jResp "ticket_field.position"]
set Raw_description [CkJsonObject_stringOf $jResp "ticket_field.raw_description"]
set Raw_title [CkJsonObject_stringOf $jResp "ticket_field.raw_title"]
set Raw_title_in_portal [CkJsonObject_stringOf $jResp "ticket_field.raw_title_in_portal"]
set Regexp_for_validation [CkJsonObject_stringOf $jResp "ticket_field.regexp_for_validation"]
set Relationship_target_type [CkJsonObject_stringOf $jResp "ticket_field.relationship_target_type"]
set Removable [CkJsonObject_stringOf $jResp "ticket_field.removable"]
set Required [CkJsonObject_stringOf $jResp "ticket_field.required"]
set Required_in_portal [CkJsonObject_stringOf $jResp "ticket_field.required_in_portal"]
set Sub_type_id [CkJsonObject_stringOf $jResp "ticket_field.sub_type_id"]
set Tag [CkJsonObject_stringOf $jResp "ticket_field.tag"]
set Title_in_portal [CkJsonObject_stringOf $jResp "ticket_field.title_in_portal"]
set Updated_at [CkJsonObject_stringOf $jResp "ticket_field.updated_at"]
set v_Url [CkJsonObject_stringOf $jResp "ticket_field.url"]
set Visible_in_portal [CkJsonObject_stringOf $jResp "ticket_field.visible_in_portal"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "ticket_field.custom_field_options"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set name [CkJsonObject_stringOf $jResp "ticket_field.custom_field_options[i].name"]
set value [CkJsonObject_stringOf $jResp "ticket_field.custom_field_options[i].value"]
set id [CkJsonObject_stringOf $jResp "ticket_field.custom_field_options[i].id"]
set position [CkJsonObject_stringOf $jResp "ticket_field.custom_field_options[i].position"]
set raw_name [CkJsonObject_stringOf $jResp "ticket_field.custom_field_options[i].raw_name"]
set url [CkJsonObject_stringOf $jResp "ticket_field.custom_field_options[i].url"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "ticket_field.custom_statuses"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set active [CkJsonObject_stringOf $jResp "ticket_field.custom_statuses[i].active"]
set agent_label [CkJsonObject_stringOf $jResp "ticket_field.custom_statuses[i].agent_label"]
set created_at [CkJsonObject_stringOf $jResp "ticket_field.custom_statuses[i].created_at"]
set default [CkJsonObject_stringOf $jResp "ticket_field.custom_statuses[i].default"]
set description [CkJsonObject_stringOf $jResp "ticket_field.custom_statuses[i].description"]
set end_user_description [CkJsonObject_stringOf $jResp "ticket_field.custom_statuses[i].end_user_description"]
set end_user_label [CkJsonObject_stringOf $jResp "ticket_field.custom_statuses[i].end_user_label"]
set id [CkJsonObject_stringOf $jResp "ticket_field.custom_statuses[i].id"]
set status_category [CkJsonObject_stringOf $jResp "ticket_field.custom_statuses[i].status_category"]
set updated_at [CkJsonObject_stringOf $jResp "ticket_field.custom_statuses[i].updated_at"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "ticket_field.system_field_options"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set name [CkJsonObject_stringOf $jResp "ticket_field.system_field_options[i].name"]
set value [CkJsonObject_stringOf $jResp "ticket_field.system_field_options[i].value"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}
