Chilkat Online Tools

TCL / Support API / Update Ticket Form

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"

CkHttp_SetRequestHeader $http "Accept" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequest $http "PUT" "https://example.zendesk.com/api/v2/ticket_forms/:ticket_form_id"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "ticket_form": {
#     "name": "<string>",
#     "active": "<boolean>",
#     "agent_conditions": [
#       {
#         "aliqua6": "proident deserunt",
#         "Lorem_d": "cillum dolor Excepteur ut",
#         "mollit_cf": -33059877,
#         "ullamco_f7": "dolore occaeca"
#       },
#       {
#         "consequate_": 29214347.18513973,
#         "consectetur_00": 83697330,
#         "laborum50": "cillum Ut"
#       }
#     ],
#     "created_at": "<dateTime>",
#     "default": "<boolean>",
#     "display_name": "<string>",
#     "end_user_conditions": [
#       {
#         "irure__c": false,
#         "Excepteur_38": -15203265.607602075,
#         "sunt_8": "culpa laboris Ut"
#       },
#       {
#         "nulla_48": "quis esse",
#         "ullamco_f6": -25516091.19614251
#       }
#     ],
#     "end_user_visible": "<boolean>",
#     "id": "<integer>",
#     "in_all_brands": "<boolean>",
#     "position": "<integer>",
#     "raw_display_name": "<string>",
#     "raw_name": "<string>",
#     "restricted_brand_ids": [
#       "<integer>",
#       "<integer>"
#     ],
#     "ticket_field_ids": [
#       "<integer>",
#       "<integer>"
#     ],
#     "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

set Name [CkJsonObject_stringOf $jResp "ticket_form.name"]
set Active [CkJsonObject_stringOf $jResp "ticket_form.active"]
set Created_at [CkJsonObject_stringOf $jResp "ticket_form.created_at"]
set Default [CkJsonObject_stringOf $jResp "ticket_form.default"]
set Display_name [CkJsonObject_stringOf $jResp "ticket_form.display_name"]
set End_user_visible [CkJsonObject_stringOf $jResp "ticket_form.end_user_visible"]
set Id [CkJsonObject_stringOf $jResp "ticket_form.id"]
set In_all_brands [CkJsonObject_stringOf $jResp "ticket_form.in_all_brands"]
set Position [CkJsonObject_stringOf $jResp "ticket_form.position"]
set Raw_display_name [CkJsonObject_stringOf $jResp "ticket_form.raw_display_name"]
set Raw_name [CkJsonObject_stringOf $jResp "ticket_form.raw_name"]
set Updated_at [CkJsonObject_stringOf $jResp "ticket_form.updated_at"]
set v_Url [CkJsonObject_stringOf $jResp "ticket_form.url"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "ticket_form.agent_conditions"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set aliqua6 [CkJsonObject_stringOf $jResp "ticket_form.agent_conditions[i].aliqua6"]
    set Lorem_d [CkJsonObject_stringOf $jResp "ticket_form.agent_conditions[i].Lorem_d"]
    set mollit_cf [CkJsonObject_IntOf $jResp "ticket_form.agent_conditions[i].mollit_cf"]
    set ullamco_f7 [CkJsonObject_stringOf $jResp "ticket_form.agent_conditions[i].ullamco_f7"]
    set consequate_ [CkJsonObject_stringOf $jResp "ticket_form.agent_conditions[i].consequate_"]
    set consectetur_00 [CkJsonObject_IntOf $jResp "ticket_form.agent_conditions[i].consectetur_00"]
    set laborum50 [CkJsonObject_stringOf $jResp "ticket_form.agent_conditions[i].laborum50"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "ticket_form.end_user_conditions"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set irure__c [CkJsonObject_BoolOf $jResp "ticket_form.end_user_conditions[i].irure__c"]
    set Excepteur_38 [CkJsonObject_stringOf $jResp "ticket_form.end_user_conditions[i].Excepteur_38"]
    set sunt_8 [CkJsonObject_stringOf $jResp "ticket_form.end_user_conditions[i].sunt_8"]
    set nulla_48 [CkJsonObject_stringOf $jResp "ticket_form.end_user_conditions[i].nulla_48"]
    set ullamco_f6 [CkJsonObject_stringOf $jResp "ticket_form.end_user_conditions[i].ullamco_f6"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "ticket_form.restricted_brand_ids"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "ticket_form.restricted_brand_ids[i]"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "ticket_form.ticket_field_ids"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "ticket_form.ticket_field_ids[i]"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

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

Postman Collection Item JSON

{
  "name": "Update Ticket Form",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/ticket_forms/:ticket_form_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "ticket_forms",
        ":ticket_form_id"
      ],
      "variable": [
        {
          "key": "ticket_form_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed For\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_forms/:ticket_form_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "ticket_forms",
            ":ticket_form_id"
          ],
          "variable": [
            {
              "key": "ticket_form_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"ticket_form\": {\n    \"name\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"agent_conditions\": [\n      {\n        \"aliqua6\": \"proident deserunt\",\n        \"Lorem_d\": \"cillum dolor Excepteur ut\",\n        \"mollit_cf\": -33059877,\n        \"ullamco_f7\": \"dolore occaeca\"\n      },\n      {\n        \"consequate_\": 29214347.18513973,\n        \"consectetur_00\": 83697330,\n        \"laborum50\": \"cillum Ut\"\n      }\n    ],\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"display_name\": \"<string>\",\n    \"end_user_conditions\": [\n      {\n        \"irure__c\": false,\n        \"Excepteur_38\": -15203265.607602075,\n        \"sunt_8\": \"culpa laboris Ut\"\n      },\n      {\n        \"nulla_48\": \"quis esse\",\n        \"ullamco_f6\": -25516091.19614251\n      }\n    ],\n    \"end_user_visible\": \"<boolean>\",\n    \"id\": \"<integer>\",\n    \"in_all_brands\": \"<boolean>\",\n    \"position\": \"<integer>\",\n    \"raw_display_name\": \"<string>\",\n    \"raw_name\": \"<string>\",\n    \"restricted_brand_ids\": [\n      \"<integer>\",\n      \"<integer>\"\n    ],\n    \"ticket_field_ids\": [\n      \"<integer>\",\n      \"<integer>\"\n    ],\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}