PureBasic / Support API / Create Ticket Field
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "login")
CkHttp::setCkPassword(http, "password")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckQuickRequest(http,"POST","https://example.zendesk.com/api/v2/ticket_fields")
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
name.s
value.s
id.s
position.s
raw_name.s
url.s
active.s
agent_label.s
created_at.s
default.s
description.s
end_user_description.s
end_user_label.s
status_category.s
updated_at.s
v_Type.s = CkJsonObject::ckStringOf(jResp,"ticket_field.type")
Title.s = CkJsonObject::ckStringOf(jResp,"ticket_field.title")
Active.s = CkJsonObject::ckStringOf(jResp,"ticket_field.active")
Agent_description.s = CkJsonObject::ckStringOf(jResp,"ticket_field.agent_description")
Collapsed_for_agents.s = CkJsonObject::ckStringOf(jResp,"ticket_field.collapsed_for_agents")
Created_at.s = CkJsonObject::ckStringOf(jResp,"ticket_field.created_at")
Description.s = CkJsonObject::ckStringOf(jResp,"ticket_field.description")
Editable_in_portal.s = CkJsonObject::ckStringOf(jResp,"ticket_field.editable_in_portal")
Id.s = CkJsonObject::ckStringOf(jResp,"ticket_field.id")
Position.s = CkJsonObject::ckStringOf(jResp,"ticket_field.position")
Raw_description.s = CkJsonObject::ckStringOf(jResp,"ticket_field.raw_description")
Raw_title.s = CkJsonObject::ckStringOf(jResp,"ticket_field.raw_title")
Raw_title_in_portal.s = CkJsonObject::ckStringOf(jResp,"ticket_field.raw_title_in_portal")
Regexp_for_validation.s = CkJsonObject::ckStringOf(jResp,"ticket_field.regexp_for_validation")
Relationship_target_type.s = CkJsonObject::ckStringOf(jResp,"ticket_field.relationship_target_type")
Removable.s = CkJsonObject::ckStringOf(jResp,"ticket_field.removable")
Required.s = CkJsonObject::ckStringOf(jResp,"ticket_field.required")
Required_in_portal.s = CkJsonObject::ckStringOf(jResp,"ticket_field.required_in_portal")
Sub_type_id.s = CkJsonObject::ckStringOf(jResp,"ticket_field.sub_type_id")
Tag.s = CkJsonObject::ckStringOf(jResp,"ticket_field.tag")
Title_in_portal.s = CkJsonObject::ckStringOf(jResp,"ticket_field.title_in_portal")
Updated_at.s = CkJsonObject::ckStringOf(jResp,"ticket_field.updated_at")
v_Url.s = CkJsonObject::ckStringOf(jResp,"ticket_field.url")
Visible_in_portal.s = CkJsonObject::ckStringOf(jResp,"ticket_field.visible_in_portal")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"ticket_field.custom_field_options")
While i < count_i
CkJsonObject::setCkI(jResp, i)
name = CkJsonObject::ckStringOf(jResp,"ticket_field.custom_field_options[i].name")
value = CkJsonObject::ckStringOf(jResp,"ticket_field.custom_field_options[i].value")
id = CkJsonObject::ckStringOf(jResp,"ticket_field.custom_field_options[i].id")
position = CkJsonObject::ckStringOf(jResp,"ticket_field.custom_field_options[i].position")
raw_name = CkJsonObject::ckStringOf(jResp,"ticket_field.custom_field_options[i].raw_name")
url = CkJsonObject::ckStringOf(jResp,"ticket_field.custom_field_options[i].url")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"ticket_field.custom_statuses")
While i < count_i
CkJsonObject::setCkI(jResp, i)
active = CkJsonObject::ckStringOf(jResp,"ticket_field.custom_statuses[i].active")
agent_label = CkJsonObject::ckStringOf(jResp,"ticket_field.custom_statuses[i].agent_label")
created_at = CkJsonObject::ckStringOf(jResp,"ticket_field.custom_statuses[i].created_at")
default = CkJsonObject::ckStringOf(jResp,"ticket_field.custom_statuses[i].default")
description = CkJsonObject::ckStringOf(jResp,"ticket_field.custom_statuses[i].description")
end_user_description = CkJsonObject::ckStringOf(jResp,"ticket_field.custom_statuses[i].end_user_description")
end_user_label = CkJsonObject::ckStringOf(jResp,"ticket_field.custom_statuses[i].end_user_label")
id = CkJsonObject::ckStringOf(jResp,"ticket_field.custom_statuses[i].id")
status_category = CkJsonObject::ckStringOf(jResp,"ticket_field.custom_statuses[i].status_category")
updated_at = CkJsonObject::ckStringOf(jResp,"ticket_field.custom_statuses[i].updated_at")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"ticket_field.system_field_options")
While i < count_i
CkJsonObject::setCkI(jResp, i)
name = CkJsonObject::ckStringOf(jResp,"ticket_field.system_field_options[i].name")
value = CkJsonObject::ckStringOf(jResp,"ticket_field.system_field_options[i].value")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
