Chilkat Online Tools

Xojo / Support API / Update Ticket 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 Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "login"
http.Password = "password"

http.SetRequestHeader "Accept","application/json"

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/ticket_fields/:ticket_field_id")
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

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

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 active As String
Dim agent_label As String
Dim created_at As String
Dim default As String
Dim description As String
Dim end_user_description As String
Dim end_user_label As String
Dim status_category As String
Dim updated_at As String

Dim v_Type As String
v_Type = jResp.StringOf("ticket_field.type")
Dim Title As String
Title = jResp.StringOf("ticket_field.title")
Dim Active As String
Active = jResp.StringOf("ticket_field.active")
Dim Agent_description As String
Agent_description = jResp.StringOf("ticket_field.agent_description")
Dim Collapsed_for_agents As String
Collapsed_for_agents = jResp.StringOf("ticket_field.collapsed_for_agents")
Dim Created_at As String
Created_at = jResp.StringOf("ticket_field.created_at")
Dim Description As String
Description = jResp.StringOf("ticket_field.description")
Dim Editable_in_portal As String
Editable_in_portal = jResp.StringOf("ticket_field.editable_in_portal")
Dim Id As String
Id = jResp.StringOf("ticket_field.id")
Dim Position As String
Position = jResp.StringOf("ticket_field.position")
Dim Raw_description As String
Raw_description = jResp.StringOf("ticket_field.raw_description")
Dim Raw_title As String
Raw_title = jResp.StringOf("ticket_field.raw_title")
Dim Raw_title_in_portal As String
Raw_title_in_portal = jResp.StringOf("ticket_field.raw_title_in_portal")
Dim Regexp_for_validation As String
Regexp_for_validation = jResp.StringOf("ticket_field.regexp_for_validation")
Dim Relationship_target_type As String
Relationship_target_type = jResp.StringOf("ticket_field.relationship_target_type")
Dim Removable As String
Removable = jResp.StringOf("ticket_field.removable")
Dim Required As String
Required = jResp.StringOf("ticket_field.required")
Dim Required_in_portal As String
Required_in_portal = jResp.StringOf("ticket_field.required_in_portal")
Dim Sub_type_id As String
Sub_type_id = jResp.StringOf("ticket_field.sub_type_id")
Dim Tag As String
Tag = jResp.StringOf("ticket_field.tag")
Dim Title_in_portal As String
Title_in_portal = jResp.StringOf("ticket_field.title_in_portal")
Dim Updated_at As String
Updated_at = jResp.StringOf("ticket_field.updated_at")
Dim v_Url As String
v_Url = jResp.StringOf("ticket_field.url")
Dim Visible_in_portal As String
Visible_in_portal = jResp.StringOf("ticket_field.visible_in_portal")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("ticket_field.custom_field_options")
While i < count_i
    jResp.I = i
    name = jResp.StringOf("ticket_field.custom_field_options[i].name")
    value = jResp.StringOf("ticket_field.custom_field_options[i].value")
    id = jResp.StringOf("ticket_field.custom_field_options[i].id")
    position = jResp.StringOf("ticket_field.custom_field_options[i].position")
    raw_name = jResp.StringOf("ticket_field.custom_field_options[i].raw_name")
    url = jResp.StringOf("ticket_field.custom_field_options[i].url")
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("ticket_field.custom_statuses")
While i < count_i
    jResp.I = i
    active = jResp.StringOf("ticket_field.custom_statuses[i].active")
    agent_label = jResp.StringOf("ticket_field.custom_statuses[i].agent_label")
    created_at = jResp.StringOf("ticket_field.custom_statuses[i].created_at")
    default = jResp.StringOf("ticket_field.custom_statuses[i].default")
    description = jResp.StringOf("ticket_field.custom_statuses[i].description")
    end_user_description = jResp.StringOf("ticket_field.custom_statuses[i].end_user_description")
    end_user_label = jResp.StringOf("ticket_field.custom_statuses[i].end_user_label")
    id = jResp.StringOf("ticket_field.custom_statuses[i].id")
    status_category = jResp.StringOf("ticket_field.custom_statuses[i].status_category")
    updated_at = jResp.StringOf("ticket_field.custom_statuses[i].updated_at")
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("ticket_field.system_field_options")
While i < count_i
    jResp.I = i
    name = jResp.StringOf("ticket_field.system_field_options[i].name")
    value = jResp.StringOf("ticket_field.system_field_options[i].value")
    i = i + 1
Wend

Curl Command

curl  -u login:password -X PUT
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/ticket_fields/:ticket_field_id

Postman Collection Item JSON

{
  "name": "Update Ticket Field",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/ticket_fields/:ticket_field_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "ticket_fields",
        ":ticket_field_id"
      ],
      "variable": [
        {
          "key": "ticket_field_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Updating drop-down field options\n\nYou can also use the update endpoint to add, update, or remove options in a drop-down custom field. Updating field options for multi-select fields works exactly the same as drop-down field options.\n\n**Important**: Unless you want to remove some options, you must specify all existing options in any update request. Omitting an option removes it from the drop-down field, which removes its values from any tickets or macros.\n\nUse the `custom_field_options` attribute to update the options. The attribute consists of an array of option objects, with each object consisting of a `name` and `value` property. The properties correspond to the \"Title\" and \"Tag\" text boxes in the admin interface. Example request body:\n\n```json\n{\"ticket_field\": {\n    \"custom_field_options\": [\n      {\"name\": \"Apple Pie\", \"value\": \"apple\"},\n      {\"name\": \"Pecan Pie\", \"value\": \"pecan\"}\n    ]\n  }\n}\n```\n\n#### Example Request\n\n```bash\ncurl https://{subdomain}.zendesk.com/api/v2/ticket_fields/{id}.json \\\n  -d '{\"ticket_field\": {\"custom_field_options\": [{\"name\": \"Apple Pie\", \"value\": \"apple\"}, {\"name\": \"Pecan Pie\", \"value\": \"pecan\"}]}}' \\\n  -H \"Content-Type: application/json\" -X PUT \\\n  -v -u {email_address}:{password}\n```\n\n#### Example Response\n\n```http\nStatus: 200 OK\n\n{\n  \"ticket_field\": {\n    \"id\":21938362,\n    \"type\":\"tagger\",\n    \"title\":\"Pies\",\n    ...\n    \"custom_field_options\": [\n      {\n        \"id\":21029772,\n        \"name\":\"Apple Pie\",\n        \"raw_name\":\"Apple Pie\",\n        \"value\":\"apple\",\n        \"default\":false\n      },\n      ...\n    ]\n  }\n}\n```\n\n#### Allowed for\n\n* Admins\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/ticket_fields/:ticket_field_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "ticket_fields",
            ":ticket_field_id"
          ],
          "variable": [
            {
              "key": "ticket_field_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_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}"
    }
  ]
}