TCL / Support API / Update Request
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/requests/:request_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)
# {
# "request": {
# "subject": "<string>",
# "assignee_id": "<integer>",
# "can_be_solved_by_me": "<boolean>",
# "collaborator_ids": [
# "<integer>",
# "<integer>"
# ],
# "created_at": "<dateTime>",
# "custom_fields": [
# {
# "id": "<integer>",
# "value": "<string>"
# },
# {
# "id": "<integer>",
# "value": "<string>"
# }
# ],
# "custom_status_id": "<integer>",
# "description": "<string>",
# "due_at": "<dateTime>",
# "email_cc_ids": [
# "<integer>",
# "<integer>"
# ],
# "followup_source_id": "<integer>",
# "group_id": "<integer>",
# "id": "<integer>",
# "is_public": "<boolean>",
# "organization_id": "<integer>",
# "priority": "<string>",
# "recipient": "<string>",
# "requester_id": "<integer>",
# "solved": "<boolean>",
# "status": "<string>",
# "ticket_form_id": "<integer>",
# "type": "<string>",
# "updated_at": "<dateTime>",
# "url": "<string>",
# "via": {
# "channel": "<string>",
# "source": {
# "est__": false
# }
# }
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set Subject [CkJsonObject_stringOf $jResp "request.subject"]
set Assignee_id [CkJsonObject_stringOf $jResp "request.assignee_id"]
set Can_be_solved_by_me [CkJsonObject_stringOf $jResp "request.can_be_solved_by_me"]
set Created_at [CkJsonObject_stringOf $jResp "request.created_at"]
set Custom_status_id [CkJsonObject_stringOf $jResp "request.custom_status_id"]
set Description [CkJsonObject_stringOf $jResp "request.description"]
set Due_at [CkJsonObject_stringOf $jResp "request.due_at"]
set Followup_source_id [CkJsonObject_stringOf $jResp "request.followup_source_id"]
set Group_id [CkJsonObject_stringOf $jResp "request.group_id"]
set Id [CkJsonObject_stringOf $jResp "request.id"]
set Is_public [CkJsonObject_stringOf $jResp "request.is_public"]
set Organization_id [CkJsonObject_stringOf $jResp "request.organization_id"]
set Priority [CkJsonObject_stringOf $jResp "request.priority"]
set Recipient [CkJsonObject_stringOf $jResp "request.recipient"]
set Requester_id [CkJsonObject_stringOf $jResp "request.requester_id"]
set Solved [CkJsonObject_stringOf $jResp "request.solved"]
set Status [CkJsonObject_stringOf $jResp "request.status"]
set Ticket_form_id [CkJsonObject_stringOf $jResp "request.ticket_form_id"]
set v_Type [CkJsonObject_stringOf $jResp "request.type"]
set Updated_at [CkJsonObject_stringOf $jResp "request.updated_at"]
set v_Url [CkJsonObject_stringOf $jResp "request.url"]
set Channel [CkJsonObject_stringOf $jResp "request.via.channel"]
set Est__ [CkJsonObject_BoolOf $jResp "request.via.source.est__"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "request.collaborator_ids"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "request.collaborator_ids[i]"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "request.custom_fields"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_stringOf $jResp "request.custom_fields[i].id"]
set value [CkJsonObject_stringOf $jResp "request.custom_fields[i].value"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "request.email_cc_ids"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "request.email_cc_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/requests/:request_id
Postman Collection Item JSON
{
"name": "Update Request",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/requests/:request_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"requests",
":request_id"
],
"variable": [
{
"key": "request_id",
"value": "<integer>"
}
]
},
"description": "Updates a request with a comment or collaborators (cc's). The end user who created the request can also use it to mark the request as solved. The endpoint can't be used to update other request attributes.\n\n#### Writable properties\nThis endpoint can only update the following properties in the request.\n\n| Name | Type | Required | Description |\n| ------------------------ | ------- | -------- | ---------------------------------------------------- |\n| comment | object | no | Adds a comment to the request. See [Request comments](#request-comments) |\n| solved | boolean | no | Marks the request as solved. Example: `{\"request\": {\"solved\": \"true\"}}` |\n| additional_collaborators | array | no | Adds collaborators to the request. An email notification is sent to them when the ticket is updated. See [Adding collaborators](/documentation/ticketing/managing-tickets/creating-and-managing-requests#adding-collaborators) |\n\n#### Allowed For\n\n* End users\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/requests/:request_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"requests",
":request_id"
],
"variable": [
{
"key": "request_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"request\": {\n \"subject\": \"<string>\",\n \"assignee_id\": \"<integer>\",\n \"can_be_solved_by_me\": \"<boolean>\",\n \"collaborator_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"created_at\": \"<dateTime>\",\n \"custom_fields\": [\n {\n \"id\": \"<integer>\",\n \"value\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"value\": \"<string>\"\n }\n ],\n \"custom_status_id\": \"<integer>\",\n \"description\": \"<string>\",\n \"due_at\": \"<dateTime>\",\n \"email_cc_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"followup_source_id\": \"<integer>\",\n \"group_id\": \"<integer>\",\n \"id\": \"<integer>\",\n \"is_public\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"priority\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester_id\": \"<integer>\",\n \"solved\": \"<boolean>\",\n \"status\": \"<string>\",\n \"ticket_form_id\": \"<integer>\",\n \"type\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"est__\": false\n }\n }\n }\n}"
}
]
}
