Xojo / Support API / Create 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
resp = http.QuickRequest("POST","https://example.zendesk.com/api/v2/requests")
If (http.LastMethodSuccess = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(resp.Header)
System.DebugLog("Failed.")
Return
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
Subject = jResp.StringOf("request.subject")
Dim Assignee_id As String
Assignee_id = jResp.StringOf("request.assignee_id")
Dim Can_be_solved_by_me As String
Can_be_solved_by_me = jResp.StringOf("request.can_be_solved_by_me")
Dim Created_at As String
Created_at = jResp.StringOf("request.created_at")
Dim Custom_status_id As String
Custom_status_id = jResp.StringOf("request.custom_status_id")
Dim Description As String
Description = jResp.StringOf("request.description")
Dim Due_at As String
Due_at = jResp.StringOf("request.due_at")
Dim Followup_source_id As String
Followup_source_id = jResp.StringOf("request.followup_source_id")
Dim Group_id As String
Group_id = jResp.StringOf("request.group_id")
Dim Id As String
Id = jResp.StringOf("request.id")
Dim Is_public As String
Is_public = jResp.StringOf("request.is_public")
Dim Organization_id As String
Organization_id = jResp.StringOf("request.organization_id")
Dim Priority As String
Priority = jResp.StringOf("request.priority")
Dim Recipient As String
Recipient = jResp.StringOf("request.recipient")
Dim Requester_id As String
Requester_id = jResp.StringOf("request.requester_id")
Dim Solved As String
Solved = jResp.StringOf("request.solved")
Dim Status As String
Status = jResp.StringOf("request.status")
Dim Ticket_form_id As String
Ticket_form_id = jResp.StringOf("request.ticket_form_id")
Dim v_Type As String
v_Type = jResp.StringOf("request.type")
Dim Updated_at As String
Updated_at = jResp.StringOf("request.updated_at")
Dim v_Url As String
v_Url = jResp.StringOf("request.url")
Dim Channel As String
Channel = jResp.StringOf("request.via.channel")
Dim Est__ As Boolean
Est__ = jResp.BoolOf("request.via.source.est__")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("request.collaborator_ids")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("request.collaborator_ids[i]")
i = i + 1
Wend
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
Wend
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
Wend
Curl Command
curl -u login:password -X POST
-H "Accept: application/json"
https://example.zendesk.com/api/v2/requests
Postman Collection Item JSON
{
"name": "Create Request",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/requests",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"requests"
]
},
"description": "Accepts a `request` object that sets one or more properties.\n\n#### Allowed for\n\n* End users\n* Anonymous users (rate limit of 5 requests per hour for [trial accounts](/documentation/developer-tools/getting-started/getting-a-trial-or-sponsored-account-for-development/))\n\n#### Additional properties\n\nIn addition to the writable request properties in the [JSON Format table](#json-format) above, you can set the following properties when creating a request.\n\n| Name | Type | Mandatory | Comment\n| ---------------- | -------| --------- | -------\n| comment | object | yes | Describes the problem, incident, question, or task. See [Request comments](#request-comments)\n| collaborators | array | no | Adds collaborators (cc's) to the request. An email notification is sent to them when the ticket is created. See [Setting collaborators](/documentation/ticketing/managing-tickets/creating-and-managing-requests#setting-collaborators)\n| requester | object | yes* | \\*Required for anonymous requests. Specifies the requester of the anonymous request. See [Creating anonymous requests](/documentation/ticketing/managing-tickets/creating-and-managing-requests#creating-anonymous-requests)\n\n#### Creating follow-up requests\n\nOnce a ticket is closed (as distinct from solved), it can't be reopened. However, you can create a new request that references the closed ticket. To create the follow-up request, include a `via_followup_source_id` property in the `request` object that specifies the closed ticket. The parameter only works with closed tickets. It has no effect with other tickets.\n"
},
"response": [
{
"name": "Created response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/requests",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"requests"
]
}
},
"status": "Created",
"code": 201,
"_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}"
}
]
}
