VB.NET / Support API / Update Request
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 = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/requests/:request_id")
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim strVal As String
Dim id As String
Dim value As String
Dim Subject As String = jResp.StringOf("request.subject")
Dim Assignee_id As String = jResp.StringOf("request.assignee_id")
Dim Can_be_solved_by_me As String = jResp.StringOf("request.can_be_solved_by_me")
Dim Created_at As String = jResp.StringOf("request.created_at")
Dim Custom_status_id As String = jResp.StringOf("request.custom_status_id")
Dim Description As String = jResp.StringOf("request.description")
Dim Due_at As String = jResp.StringOf("request.due_at")
Dim Followup_source_id As String = jResp.StringOf("request.followup_source_id")
Dim Group_id As String = jResp.StringOf("request.group_id")
Dim Id As String = jResp.StringOf("request.id")
Dim Is_public As String = jResp.StringOf("request.is_public")
Dim Organization_id As String = jResp.StringOf("request.organization_id")
Dim Priority As String = jResp.StringOf("request.priority")
Dim Recipient As String = jResp.StringOf("request.recipient")
Dim Requester_id As String = jResp.StringOf("request.requester_id")
Dim Solved As String = jResp.StringOf("request.solved")
Dim Status As String = jResp.StringOf("request.status")
Dim Ticket_form_id As String = jResp.StringOf("request.ticket_form_id")
Dim v_Type As String = jResp.StringOf("request.type")
Dim Updated_at As String = jResp.StringOf("request.updated_at")
Dim v_Url As String = jResp.StringOf("request.url")
Dim Channel As String = jResp.StringOf("request.via.channel")
Dim Est__ As Boolean = jResp.BoolOf("request.via.source.est__")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("request.collaborator_ids")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("request.collaborator_ids[i]")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("request.custom_fields")
While i < count_i
jResp.I = i
id = jResp.StringOf("request.custom_fields[i].id")
value = jResp.StringOf("request.custom_fields[i].value")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("request.email_cc_ids")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("request.email_cc_ids[i]")
i = i + 1
End While
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}"
}
]
}
