autoit / Support API / Create Custom Object Field
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.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>"
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("custom_object_field.key","<string>")
$oJson.UpdateString("custom_object_field.type","<string>")
$oJson.UpdateString("custom_object_field.title","<string>")
$oJson.UpdateString("custom_object_field.active","<boolean>")
$oJson.UpdateString("custom_object_field.created_at","<dateTime>")
$oJson.UpdateString("custom_object_field.custom_field_options[0].name","<string>")
$oJson.UpdateString("custom_object_field.custom_field_options[0].value","<string>")
$oJson.UpdateString("custom_object_field.custom_field_options[0].id","<integer>")
$oJson.UpdateString("custom_object_field.custom_field_options[0].position","<integer>")
$oJson.UpdateString("custom_object_field.custom_field_options[0].raw_name","<string>")
$oJson.UpdateString("custom_object_field.custom_field_options[0].url","<string>")
$oJson.UpdateString("custom_object_field.custom_field_options[1].name","<string>")
$oJson.UpdateString("custom_object_field.custom_field_options[1].value","<string>")
$oJson.UpdateString("custom_object_field.custom_field_options[1].id","<integer>")
$oJson.UpdateString("custom_object_field.custom_field_options[1].position","<integer>")
$oJson.UpdateString("custom_object_field.custom_field_options[1].raw_name","<string>")
$oJson.UpdateString("custom_object_field.custom_field_options[1].url","<string>")
$oJson.UpdateString("custom_object_field.description","<string>")
$oJson.UpdateString("custom_object_field.id","<integer>")
$oJson.UpdateString("custom_object_field.position","<integer>")
$oJson.UpdateString("custom_object_field.raw_description","<string>")
$oJson.UpdateString("custom_object_field.raw_title","<string>")
$oJson.UpdateString("custom_object_field.regexp_for_validation","<string>")
$oJson.UpdateNewObject("custom_object_field.relationship_filter")
$oJson.UpdateString("custom_object_field.relationship_target_type","<string>")
$oJson.UpdateString("custom_object_field.system","<boolean>")
$oJson.UpdateString("custom_object_field.tag","<string>")
$oJson.UpdateString("custom_object_field.updated_at","<dateTime>")
$oJson.UpdateString("custom_object_field.url","<string>")
$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.PostJson3("https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sName
Local $sValue
Local $sId
Local $sPosition
Local $sRaw_name
Local $sUrl
Local $sKey = $oJResp.StringOf("custom_object_field.key")
Local $sV_Type = $oJResp.StringOf("custom_object_field.type")
Local $sTitle = $oJResp.StringOf("custom_object_field.title")
Local $sActive = $oJResp.StringOf("custom_object_field.active")
Local $sCreated_at = $oJResp.StringOf("custom_object_field.created_at")
Local $sDescription = $oJResp.StringOf("custom_object_field.description")
Local $sId = $oJResp.StringOf("custom_object_field.id")
Local $sPosition = $oJResp.StringOf("custom_object_field.position")
Local $sRaw_description = $oJResp.StringOf("custom_object_field.raw_description")
Local $sRaw_title = $oJResp.StringOf("custom_object_field.raw_title")
Local $sRegexp_for_validation = $oJResp.StringOf("custom_object_field.regexp_for_validation")
Local $sRelationship_target_type = $oJResp.StringOf("custom_object_field.relationship_target_type")
Local $sSystem = $oJResp.StringOf("custom_object_field.system")
Local $sTag = $oJResp.StringOf("custom_object_field.tag")
Local $sUpdated_at = $oJResp.StringOf("custom_object_field.updated_at")
Local $sV_Url = $oJResp.StringOf("custom_object_field.url")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("custom_object_field.custom_field_options")
While $i < $iCount_i
$oJResp.I = $i
$sName = $oJResp.StringOf("custom_object_field.custom_field_options[i].name")
$sValue = $oJResp.StringOf("custom_object_field.custom_field_options[i].value")
$sId = $oJResp.StringOf("custom_object_field.custom_field_options[i].id")
$sPosition = $oJResp.StringOf("custom_object_field.custom_field_options[i].position")
$sRaw_name = $oJResp.StringOf("custom_object_field.custom_field_options[i].raw_name")
$sUrl = $oJResp.StringOf("custom_object_field.custom_field_options[i].url")
$i = $i + 1
Wend
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}"
}
]
}
