Swift / Support API / Create Custom Object Field
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()
var success: Bool
http.BasicAuth = true
http.Login = "login"
http.Password = "password"
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "custom_object_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>"
// }
// }
let json = CkoJsonObject()
json.UpdateString("custom_object_field.key", value: "<string>")
json.UpdateString("custom_object_field.type", value: "<string>")
json.UpdateString("custom_object_field.title", value: "<string>")
json.UpdateString("custom_object_field.active", value: "<boolean>")
json.UpdateString("custom_object_field.created_at", value: "<dateTime>")
json.UpdateString("custom_object_field.custom_field_options[0].name", value: "<string>")
json.UpdateString("custom_object_field.custom_field_options[0].value", value: "<string>")
json.UpdateString("custom_object_field.custom_field_options[0].id", value: "<integer>")
json.UpdateString("custom_object_field.custom_field_options[0].position", value: "<integer>")
json.UpdateString("custom_object_field.custom_field_options[0].raw_name", value: "<string>")
json.UpdateString("custom_object_field.custom_field_options[0].url", value: "<string>")
json.UpdateString("custom_object_field.custom_field_options[1].name", value: "<string>")
json.UpdateString("custom_object_field.custom_field_options[1].value", value: "<string>")
json.UpdateString("custom_object_field.custom_field_options[1].id", value: "<integer>")
json.UpdateString("custom_object_field.custom_field_options[1].position", value: "<integer>")
json.UpdateString("custom_object_field.custom_field_options[1].raw_name", value: "<string>")
json.UpdateString("custom_object_field.custom_field_options[1].url", value: "<string>")
json.UpdateString("custom_object_field.description", value: "<string>")
json.UpdateString("custom_object_field.id", value: "<integer>")
json.UpdateString("custom_object_field.position", value: "<integer>")
json.UpdateString("custom_object_field.raw_description", value: "<string>")
json.UpdateString("custom_object_field.raw_title", value: "<string>")
json.UpdateString("custom_object_field.regexp_for_validation", value: "<string>")
json.UpdateNewObject("custom_object_field.relationship_filter")
json.UpdateString("custom_object_field.relationship_target_type", value: "<string>")
json.UpdateString("custom_object_field.system", value: "<boolean>")
json.UpdateString("custom_object_field.tag", value: "<string>")
json.UpdateString("custom_object_field.updated_at", value: "<dateTime>")
json.UpdateString("custom_object_field.url", value: "<string>")
http.SetRequestHeader("Content-Type", value: "application/json")
http.SetRequestHeader("Accept", value: "application/json")
var resp: CkoHttpResponse? = http.PostJson3("https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields", contentType: "application/json", json: json)
if http.LastMethodSuccess == false {
print("\(http.LastErrorText)")
return
}
let sbResponseBody = CkoStringBuilder()
resp!.GetBodySb(sbResponseBody)
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = resp!.StatusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.Header)")
print("Failed.")
resp = nil
return
}
resp = nil
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "custom_object_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
var name: String?
var value: String?
var id: String?
var position: String?
var raw_name: String?
var url: String?
var Key: String? = jResp.StringOf("custom_object_field.key")
var v_Type: String? = jResp.StringOf("custom_object_field.type")
var Title: String? = jResp.StringOf("custom_object_field.title")
var Active: String? = jResp.StringOf("custom_object_field.active")
var Created_at: String? = jResp.StringOf("custom_object_field.created_at")
var Description: String? = jResp.StringOf("custom_object_field.description")
var Id: String? = jResp.StringOf("custom_object_field.id")
var Position: String? = jResp.StringOf("custom_object_field.position")
var Raw_description: String? = jResp.StringOf("custom_object_field.raw_description")
var Raw_title: String? = jResp.StringOf("custom_object_field.raw_title")
var Regexp_for_validation: String? = jResp.StringOf("custom_object_field.regexp_for_validation")
var Relationship_target_type: String? = jResp.StringOf("custom_object_field.relationship_target_type")
var System: String? = jResp.StringOf("custom_object_field.system")
var Tag: String? = jResp.StringOf("custom_object_field.tag")
var Updated_at: String? = jResp.StringOf("custom_object_field.updated_at")
var v_Url: String? = jResp.StringOf("custom_object_field.url")
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("custom_object_field.custom_field_options").intValue
while i < count_i {
jResp.I = i
name = jResp.StringOf("custom_object_field.custom_field_options[i].name")
value = jResp.StringOf("custom_object_field.custom_field_options[i].value")
id = jResp.StringOf("custom_object_field.custom_field_options[i].id")
position = jResp.StringOf("custom_object_field.custom_field_options[i].position")
raw_name = jResp.StringOf("custom_object_field.custom_field_options[i].raw_name")
url = jResp.StringOf("custom_object_field.custom_field_options[i].url")
i = i + 1
}
}
Curl Command
curl -u login:password -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"custom_object_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>"
}
}'
https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields
Postman Collection Item JSON
{
"name": "Create Custom Object Field",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_object_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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"fields"
],
"variable": [
{
"key": "custom_object_key",
"value": "<string>"
}
]
},
"description": "Creates any of the following custom field types:\n\n* text (default when no \"type\" is specified)\n* textarea\n* checkbox\n* date\n* integer\n* decimal\n* regexp\n* dropdown\n* lookup\n\nSee [About custom field types](https://support.zendesk.com/hc/en-us/articles/203661866) in Zendesk help.\n\n#### Allowed For\n\n* Admins\n"
},
"response": [
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_object_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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"fields"
],
"variable": [
{
"key": "custom_object_key"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"custom_object_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}"
}
]
}
