Chilkat Tools

Node.js / Support API / Create Request

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    http.BasicAuth = true;
    http.Login = "login";
    http.Password = "password";

    http.SetRequestHeader("Accept","application/json");

    // resp: HttpResponse
    var resp = http.QuickRequest("POST","https://example.zendesk.com/api/v2/requests");
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("Failed.");

        return;
    }

    // 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

    var strVal;
    var id;
    var value;

    var Subject = jResp.StringOf("request.subject");
    var Assignee_id = jResp.StringOf("request.assignee_id");
    var Can_be_solved_by_me = jResp.StringOf("request.can_be_solved_by_me");
    var Created_at = jResp.StringOf("request.created_at");
    var Custom_status_id = jResp.StringOf("request.custom_status_id");
    var Description = jResp.StringOf("request.description");
    var Due_at = jResp.StringOf("request.due_at");
    var Followup_source_id = jResp.StringOf("request.followup_source_id");
    var Group_id = jResp.StringOf("request.group_id");
    var Id = jResp.StringOf("request.id");
    var Is_public = jResp.StringOf("request.is_public");
    var Organization_id = jResp.StringOf("request.organization_id");
    var Priority = jResp.StringOf("request.priority");
    var Recipient = jResp.StringOf("request.recipient");
    var Requester_id = jResp.StringOf("request.requester_id");
    var Solved = jResp.StringOf("request.solved");
    var Status = jResp.StringOf("request.status");
    var Ticket_form_id = jResp.StringOf("request.ticket_form_id");
    var v_Type = jResp.StringOf("request.type");
    var Updated_at = jResp.StringOf("request.updated_at");
    var v_Url = jResp.StringOf("request.url");
    var Channel = jResp.StringOf("request.via.channel");
    var Est__ = jResp.BoolOf("request.via.source.est__");
    var i = 0;
    var 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;
    }


}

chilkatExample();

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

Chilkat Online Tools

Node.js / Support API / Create Request

Curl Command

Postman Collection Item JSON