Chilkat Online Tools

VB6 / 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.

Dim http As New ChilkatHttp
Dim success As Long

http.BasicAuth = 1
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>"
'   }
' }

Dim json As New ChilkatJsonObject
success = json.UpdateString("custom_object_field.key","<string>")
success = json.UpdateString("custom_object_field.type","<string>")
success = json.UpdateString("custom_object_field.title","<string>")
success = json.UpdateString("custom_object_field.active","<boolean>")
success = json.UpdateString("custom_object_field.created_at","<dateTime>")
success = json.UpdateString("custom_object_field.custom_field_options[0].name","<string>")
success = json.UpdateString("custom_object_field.custom_field_options[0].value","<string>")
success = json.UpdateString("custom_object_field.custom_field_options[0].id","<integer>")
success = json.UpdateString("custom_object_field.custom_field_options[0].position","<integer>")
success = json.UpdateString("custom_object_field.custom_field_options[0].raw_name","<string>")
success = json.UpdateString("custom_object_field.custom_field_options[0].url","<string>")
success = json.UpdateString("custom_object_field.custom_field_options[1].name","<string>")
success = json.UpdateString("custom_object_field.custom_field_options[1].value","<string>")
success = json.UpdateString("custom_object_field.custom_field_options[1].id","<integer>")
success = json.UpdateString("custom_object_field.custom_field_options[1].position","<integer>")
success = json.UpdateString("custom_object_field.custom_field_options[1].raw_name","<string>")
success = json.UpdateString("custom_object_field.custom_field_options[1].url","<string>")
success = json.UpdateString("custom_object_field.description","<string>")
success = json.UpdateString("custom_object_field.id","<integer>")
success = json.UpdateString("custom_object_field.position","<integer>")
success = json.UpdateString("custom_object_field.raw_description","<string>")
success = json.UpdateString("custom_object_field.raw_title","<string>")
success = json.UpdateString("custom_object_field.regexp_for_validation","<string>")
success = json.UpdateNewObject("custom_object_field.relationship_filter")
success = json.UpdateString("custom_object_field.relationship_target_type","<string>")
success = json.UpdateString("custom_object_field.system","<boolean>")
success = json.UpdateString("custom_object_field.tag","<string>")
success = json.UpdateString("custom_object_field.updated_at","<dateTime>")
success = json.UpdateString("custom_object_field.url","<string>")

http.SetRequestHeader "Content-Type","application/json"
http.SetRequestHeader "Accept","application/json"

Dim resp As ChilkatHttpResponse
Set resp = http.PostJson3("https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields","application/json",json)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

' 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

Dim name As String
Dim value As String
Dim id As String
Dim position As String
Dim raw_name As String
Dim url As String

Dim Key As String
Key = jResp.StringOf("custom_object_field.key")
Dim v_Type As String
v_Type = jResp.StringOf("custom_object_field.type")
Dim Title As String
Title = jResp.StringOf("custom_object_field.title")
Dim Active As String
Active = jResp.StringOf("custom_object_field.active")
Dim Created_at As String
Created_at = jResp.StringOf("custom_object_field.created_at")
Dim Description As String
Description = jResp.StringOf("custom_object_field.description")
Dim Id As String
Id = jResp.StringOf("custom_object_field.id")
Dim Position As String
Position = jResp.StringOf("custom_object_field.position")
Dim Raw_description As String
Raw_description = jResp.StringOf("custom_object_field.raw_description")
Dim Raw_title As String
Raw_title = jResp.StringOf("custom_object_field.raw_title")
Dim Regexp_for_validation As String
Regexp_for_validation = jResp.StringOf("custom_object_field.regexp_for_validation")
Dim Relationship_target_type As String
Relationship_target_type = jResp.StringOf("custom_object_field.relationship_target_type")
Dim System As String
System = jResp.StringOf("custom_object_field.system")
Dim Tag As String
Tag = jResp.StringOf("custom_object_field.tag")
Dim Updated_at As String
Updated_at = jResp.StringOf("custom_object_field.updated_at")
Dim v_Url As String
v_Url = jResp.StringOf("custom_object_field.url")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("custom_object_field.custom_field_options")
Do 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
Loop

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}"
    }
  ]
}