Chilkat Online Tools

Objective-C / Support API / Delete multiple tickets permanently

Back to Collection Items

#import <CkoHttp.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

http.BasicAuth = YES;
http.Login = @"login";
http.Password = @"password";

[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoHttpResponse *resp = [http QuickRequest: @"DELETE" url: @"https://example.zendesk.com/api/v2/deleted_tickets/destroy_many?ids=<string>"];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"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

NSString *id = 0;
NSString *index = 0;

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

Curl Command

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

Postman Collection Item JSON

{
  "name": "Delete multiple tickets permanently",
  "request": {
    "method": "DELETE",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/deleted_tickets/destroy_many?ids=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "deleted_tickets",
        "destroy_many"
      ],
      "query": [
        {
          "key": "ids",
          "value": "<string>",
          "description": "(Required) Comma-separated list of ticket ids"
        }
      ]
    },
    "description": "Permanently deletes up to 100 soft-deleted tickets. See [Soft delete](https://support.zendesk.com/hc/en-us/articles/4408834005530#topic_zrm_wbj_1db)\nin the Zendesk GDPR docs. To soft delete tickets, use the [Bulk Delete Tickets](#bulk-delete-tickets) endpoint.\n\nThis endpoint accepts a comma-separated list of up to 100 ticket ids. It enqueues\na ticket deletion job and returns a payload with the jobs status.\n\nIf one ticket fails to be deleted, the endpoint still attempts to delete the others. If the job succeeds,\nthe tickets that were successfully deleted are permanently deleted. This operation can't be undone.\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": "DELETE",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/deleted_tickets/destroy_many?ids=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "deleted_tickets",
            "destroy_many"
          ],
          "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}"
    }
  ]
}