Chilkat Online Tools

Node.js / Support API / Bulk Mark Tickets as Spam

Back to Collection Items

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("PUT","https://example.zendesk.com/api/v2/tickets/mark_many_as_spam?ids=<string>");
    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)

    // {
    //   "job_status": {
    //     "id": "<string>",
    //     "message": "<string>",
    //     "progress": "<integer>",
    //     "results": [
    //       {
    //         "id": "<integer>",
    //         "index": "<integer>"
    //       },
    //       {
    //         "id": "<integer>",
    //         "index": "<integer>"
    //       }
    //     ],
    //     "status": "<string>",
    //     "total": "<integer>",
    //     "url": "<string>"
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var id;
    var index;

    var Id = jResp.StringOf("job_status.id");
    var Message = jResp.StringOf("job_status.message");
    var Progress = jResp.StringOf("job_status.progress");
    var Status = jResp.StringOf("job_status.status");
    var Total = jResp.StringOf("job_status.total");
    var v_Url = jResp.StringOf("job_status.url");
    var i = 0;
    var count_i = jResp.SizeOfArray("job_status.results");
    while (i < count_i) {
        jResp.I = i;
        id = jResp.StringOf("job_status.results[i].id");
        index = jResp.StringOf("job_status.results[i].index");
        i = i+1;
    }


}

chilkatExample();

Curl Command

curl  -u login:password -X PUT
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/tickets/mark_many_as_spam?ids=<string>

Postman Collection Item JSON

{
  "name": "Bulk Mark Tickets as Spam",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/tickets/mark_many_as_spam?ids=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "tickets",
        "mark_many_as_spam"
      ],
      "query": [
        {
          "key": "ids",
          "value": "<string>",
          "description": "(Required) Comma-separated list of ticket ids"
        }
      ]
    },
    "description": "Accepts a comma-separated list of up to 100 ticket ids.\n\nThis endpoint returns a `job_status` [JSON object](/api-reference/ticketing/ticket-management/job_statuses/#json-format) and queues a background job to do the work.\nUse the [Show Job Status](/api-reference/ticketing/ticket-management/job_statuses/#show-job-status) endpoint to check for the job's completion\n\n#### Allowed For\n\n* Agents"
  },
  "response": [
    {
      "name": "Successful response",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/tickets/mark_many_as_spam?ids=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "tickets",
            "mark_many_as_spam"
          ],
          "query": [
            {
              "key": "ids",
              "value": "<string>",
              "description": "(Required) Comma-separated list of ticket ids"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"job_status\": {\n    \"id\": \"<string>\",\n    \"message\": \"<string>\",\n    \"progress\": \"<integer>\",\n    \"results\": [\n      {\n        \"id\": \"<integer>\",\n        \"index\": \"<integer>\"\n      },\n      {\n        \"id\": \"<integer>\",\n        \"index\": \"<integer>\"\n      }\n    ],\n    \"status\": \"<string>\",\n    \"total\": \"<integer>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}