DataFlex / Support API / Update Ticket Field
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sName
String sValue
String sId
String sPosition
String sRaw_name
String sUrl
String sActive
String sAgent_label
String sCreated_at
String sDefault
String sDescription
String sEnd_user_description
String sEnd_user_label
String sStatus_category
String sUpdated_at
String sV_Type
String sTitle
String sActive
String sAgent_description
String sCollapsed_for_agents
String sCreated_at
String sDescription
String sEditable_in_portal
String sId
String sPosition
String sRaw_description
String sRaw_title
String sRaw_title_in_portal
String sRegexp_for_validation
String sRelationship_target_type
String sRemovable
String sRequired
String sRequired_in_portal
String sSub_type_id
String sTag
String sTitle_in_portal
String sUpdated_at
String sV_Url
String sVisible_in_portal
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Set ComBasicAuth Of hoHttp To True
Set ComLogin Of hoHttp To "login"
Set ComPassword Of hoHttp To "password"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get ComQuickRequest Of hoHttp "PUT" "https://example.zendesk.com/api/v2/ticket_fields/:ticket_field_id" To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComStringOf Of hoJResp "ticket_field.type" To sV_Type
Get ComStringOf Of hoJResp "ticket_field.title" To sTitle
Get ComStringOf Of hoJResp "ticket_field.active" To sActive
Get ComStringOf Of hoJResp "ticket_field.agent_description" To sAgent_description
Get ComStringOf Of hoJResp "ticket_field.collapsed_for_agents" To sCollapsed_for_agents
Get ComStringOf Of hoJResp "ticket_field.created_at" To sCreated_at
Get ComStringOf Of hoJResp "ticket_field.description" To sDescription
Get ComStringOf Of hoJResp "ticket_field.editable_in_portal" To sEditable_in_portal
Get ComStringOf Of hoJResp "ticket_field.id" To sId
Get ComStringOf Of hoJResp "ticket_field.position" To sPosition
Get ComStringOf Of hoJResp "ticket_field.raw_description" To sRaw_description
Get ComStringOf Of hoJResp "ticket_field.raw_title" To sRaw_title
Get ComStringOf Of hoJResp "ticket_field.raw_title_in_portal" To sRaw_title_in_portal
Get ComStringOf Of hoJResp "ticket_field.regexp_for_validation" To sRegexp_for_validation
Get ComStringOf Of hoJResp "ticket_field.relationship_target_type" To sRelationship_target_type
Get ComStringOf Of hoJResp "ticket_field.removable" To sRemovable
Get ComStringOf Of hoJResp "ticket_field.required" To sRequired
Get ComStringOf Of hoJResp "ticket_field.required_in_portal" To sRequired_in_portal
Get ComStringOf Of hoJResp "ticket_field.sub_type_id" To sSub_type_id
Get ComStringOf Of hoJResp "ticket_field.tag" To sTag
Get ComStringOf Of hoJResp "ticket_field.title_in_portal" To sTitle_in_portal
Get ComStringOf Of hoJResp "ticket_field.updated_at" To sUpdated_at
Get ComStringOf Of hoJResp "ticket_field.url" To sV_Url
Get ComStringOf Of hoJResp "ticket_field.visible_in_portal" To sVisible_in_portal
Move 0 To i
Get ComSizeOfArray Of hoJResp "ticket_field.custom_field_options" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "ticket_field.custom_field_options[i].name" To sName
Get ComStringOf Of hoJResp "ticket_field.custom_field_options[i].value" To sValue
Get ComStringOf Of hoJResp "ticket_field.custom_field_options[i].id" To sId
Get ComStringOf Of hoJResp "ticket_field.custom_field_options[i].position" To sPosition
Get ComStringOf Of hoJResp "ticket_field.custom_field_options[i].raw_name" To sRaw_name
Get ComStringOf Of hoJResp "ticket_field.custom_field_options[i].url" To sUrl
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "ticket_field.custom_statuses" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "ticket_field.custom_statuses[i].active" To sActive
Get ComStringOf Of hoJResp "ticket_field.custom_statuses[i].agent_label" To sAgent_label
Get ComStringOf Of hoJResp "ticket_field.custom_statuses[i].created_at" To sCreated_at
Get ComStringOf Of hoJResp "ticket_field.custom_statuses[i].default" To sDefault
Get ComStringOf Of hoJResp "ticket_field.custom_statuses[i].description" To sDescription
Get ComStringOf Of hoJResp "ticket_field.custom_statuses[i].end_user_description" To sEnd_user_description
Get ComStringOf Of hoJResp "ticket_field.custom_statuses[i].end_user_label" To sEnd_user_label
Get ComStringOf Of hoJResp "ticket_field.custom_statuses[i].id" To sId
Get ComStringOf Of hoJResp "ticket_field.custom_statuses[i].status_category" To sStatus_category
Get ComStringOf Of hoJResp "ticket_field.custom_statuses[i].updated_at" To sUpdated_at
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "ticket_field.system_field_options" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "ticket_field.system_field_options[i].name" To sName
Get ComStringOf Of hoJResp "ticket_field.system_field_options[i].value" To sValue
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
