autoit / 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.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequest("POST","https://example.zendesk.com/api/v2/requests")
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $strVal
Local $sId
Local $sValue
Local $sSubject = $oJResp.StringOf("request.subject")
Local $sAssignee_id = $oJResp.StringOf("request.assignee_id")
Local $sCan_be_solved_by_me = $oJResp.StringOf("request.can_be_solved_by_me")
Local $sCreated_at = $oJResp.StringOf("request.created_at")
Local $sCustom_status_id = $oJResp.StringOf("request.custom_status_id")
Local $sDescription = $oJResp.StringOf("request.description")
Local $sDue_at = $oJResp.StringOf("request.due_at")
Local $sFollowup_source_id = $oJResp.StringOf("request.followup_source_id")
Local $sGroup_id = $oJResp.StringOf("request.group_id")
Local $sId = $oJResp.StringOf("request.id")
Local $sIs_public = $oJResp.StringOf("request.is_public")
Local $sOrganization_id = $oJResp.StringOf("request.organization_id")
Local $sPriority = $oJResp.StringOf("request.priority")
Local $sRecipient = $oJResp.StringOf("request.recipient")
Local $sRequester_id = $oJResp.StringOf("request.requester_id")
Local $sSolved = $oJResp.StringOf("request.solved")
Local $sStatus = $oJResp.StringOf("request.status")
Local $sTicket_form_id = $oJResp.StringOf("request.ticket_form_id")
Local $sV_Type = $oJResp.StringOf("request.type")
Local $sUpdated_at = $oJResp.StringOf("request.updated_at")
Local $sV_Url = $oJResp.StringOf("request.url")
Local $sChannel = $oJResp.StringOf("request.via.channel")
Local $bEst__ = $oJResp.BoolOf("request.via.source.est__")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("request.collaborator_ids")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.StringOf("request.collaborator_ids[i]")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("request.custom_fields")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("request.custom_fields[i].id")
$sValue = $oJResp.StringOf("request.custom_fields[i].value")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("request.email_cc_ids")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.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}"
}
]
}