Chilkat Online Tools

VBScript / Support API / Update Request

Back to Collection Items

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
Set outFile = fso.CreateTextFile("output.txt", True)

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

set http = CreateObject("Chilkat_9_5_0.Http")

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

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

' resp is a Chilkat_9_5_0.HttpResponse
Set resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/requests/:request_id")
If (http.LastMethodSuccess = 0) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

set sbResponseBody = CreateObject("Chilkat_9_5_0.StringBuilder")
success = resp.GetBodySb(sbResponseBody)

set jResp = CreateObject("Chilkat_9_5_0.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())

respStatusCode = resp.StatusCode
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    outFile.WriteLine("Response Header:")
    outFile.WriteLine(resp.Header)
    outFile.WriteLine("Failed.")

    WScript.Quit
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

Subject = jResp.StringOf("request.subject")
Assignee_id = jResp.StringOf("request.assignee_id")
Can_be_solved_by_me = jResp.StringOf("request.can_be_solved_by_me")
Created_at = jResp.StringOf("request.created_at")
Custom_status_id = jResp.StringOf("request.custom_status_id")
Description = jResp.StringOf("request.description")
Due_at = jResp.StringOf("request.due_at")
Followup_source_id = jResp.StringOf("request.followup_source_id")
Group_id = jResp.StringOf("request.group_id")
Id = jResp.StringOf("request.id")
Is_public = jResp.StringOf("request.is_public")
Organization_id = jResp.StringOf("request.organization_id")
Priority = jResp.StringOf("request.priority")
Recipient = jResp.StringOf("request.recipient")
Requester_id = jResp.StringOf("request.requester_id")
Solved = jResp.StringOf("request.solved")
Status = jResp.StringOf("request.status")
Ticket_form_id = jResp.StringOf("request.ticket_form_id")
v_Type = jResp.StringOf("request.type")
Updated_at = jResp.StringOf("request.updated_at")
v_Url = jResp.StringOf("request.url")
Channel = jResp.StringOf("request.via.channel")
Est__ = jResp.BoolOf("request.via.source.est__")
i = 0
count_i = jResp.SizeOfArray("request.collaborator_ids")
Do While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("request.collaborator_ids[i]")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("request.custom_fields")
Do 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
Loop
i = 0
count_i = jResp.SizeOfArray("request.email_cc_ids")
Do While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("request.email_cc_ids[i]")
    i = i + 1
Loop

outFile.Close

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}"
    }
  ]
}