Powershell / Support API / Create Custom Object Field
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$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>"
# }
# }
$json = New-Object Chilkat.JsonObject
$json.UpdateString("custom_object_field.key","<string>")
$json.UpdateString("custom_object_field.type","<string>")
$json.UpdateString("custom_object_field.title","<string>")
$json.UpdateString("custom_object_field.active","<boolean>")
$json.UpdateString("custom_object_field.created_at","<dateTime>")
$json.UpdateString("custom_object_field.custom_field_options[0].name","<string>")
$json.UpdateString("custom_object_field.custom_field_options[0].value","<string>")
$json.UpdateString("custom_object_field.custom_field_options[0].id","<integer>")
$json.UpdateString("custom_object_field.custom_field_options[0].position","<integer>")
$json.UpdateString("custom_object_field.custom_field_options[0].raw_name","<string>")
$json.UpdateString("custom_object_field.custom_field_options[0].url","<string>")
$json.UpdateString("custom_object_field.custom_field_options[1].name","<string>")
$json.UpdateString("custom_object_field.custom_field_options[1].value","<string>")
$json.UpdateString("custom_object_field.custom_field_options[1].id","<integer>")
$json.UpdateString("custom_object_field.custom_field_options[1].position","<integer>")
$json.UpdateString("custom_object_field.custom_field_options[1].raw_name","<string>")
$json.UpdateString("custom_object_field.custom_field_options[1].url","<string>")
$json.UpdateString("custom_object_field.description","<string>")
$json.UpdateString("custom_object_field.id","<integer>")
$json.UpdateString("custom_object_field.position","<integer>")
$json.UpdateString("custom_object_field.raw_description","<string>")
$json.UpdateString("custom_object_field.raw_title","<string>")
$json.UpdateString("custom_object_field.regexp_for_validation","<string>")
$json.UpdateNewObject("custom_object_field.relationship_filter")
$json.UpdateString("custom_object_field.relationship_target_type","<string>")
$json.UpdateString("custom_object_field.system","<boolean>")
$json.UpdateString("custom_object_field.tag","<string>")
$json.UpdateString("custom_object_field.updated_at","<dateTime>")
$json.UpdateString("custom_object_field.url","<string>")
$http.SetRequestHeader("Content-Type","application/json")
$http.SetRequestHeader("Accept","application/json")
$resp = $http.PostJson3("https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields","application/json",$json)
if ($http.LastMethodSuccess -eq $false) {
$($http.LastErrorText)
exit
}
$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($resp.Header)
$("Failed.")
exit
}
# 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
$Key = $jResp.StringOf("custom_object_field.key")
$v_Type = $jResp.StringOf("custom_object_field.type")
$Title = $jResp.StringOf("custom_object_field.title")
$Active = $jResp.StringOf("custom_object_field.active")
$Created_at = $jResp.StringOf("custom_object_field.created_at")
$Description = $jResp.StringOf("custom_object_field.description")
$Id = $jResp.StringOf("custom_object_field.id")
$Position = $jResp.StringOf("custom_object_field.position")
$Raw_description = $jResp.StringOf("custom_object_field.raw_description")
$Raw_title = $jResp.StringOf("custom_object_field.raw_title")
$Regexp_for_validation = $jResp.StringOf("custom_object_field.regexp_for_validation")
$Relationship_target_type = $jResp.StringOf("custom_object_field.relationship_target_type")
$System = $jResp.StringOf("custom_object_field.system")
$Tag = $jResp.StringOf("custom_object_field.tag")
$Updated_at = $jResp.StringOf("custom_object_field.updated_at")
$v_Url = $jResp.StringOf("custom_object_field.url")
$i = 0
$count_i = $jResp.SizeOfArray("custom_object_field.custom_field_options")
while ($i -lt $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}"
}
]
}
