phpAx / Support API / Create Request
Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new COM("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
$resp = $http->QuickRequest('POST','https://example.zendesk.com/api/v2/requests');
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$resp->GetBodySb($sbResponseBody);
$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// 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');
while ($i < $count_i) {
$jResp->I = $i;
$strVal = $jResp->stringOf('request.collaborator_ids[i]');
$i = $i + 1;
}
$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;
}
$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;
}
?>
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}"
}
]
}
