Chilkat Online Tools

C++ / Support API / Bulk Delete Organizations

Back to Collection Items

#include <CkHttp.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>

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

    CkHttp http;
    bool success;

    http.put_BasicAuth(true);
    http.put_Login("login");
    http.put_Password("password");

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

    CkHttpResponse *resp = http.QuickRequest("DELETE","https://example.zendesk.com/api/v2/organizations/destroy_many?ids=<string>&external_ids=<string>");
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *id = 0;
    const char *index = 0;

    const char *Id = jResp.stringOf("job_status.id");
    const char *Message = jResp.stringOf("job_status.message");
    const char *Progress = jResp.stringOf("job_status.progress");
    const char *Status = jResp.stringOf("job_status.status");
    const char *Total = jResp.stringOf("job_status.total");
    const char *v_Url = jResp.stringOf("job_status.url");
    int i = 0;
    int count_i = jResp.SizeOfArray("job_status.results");
    while (i < count_i) {
        jResp.put_I(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/organizations/destroy_many?ids=<string>&external_ids=<string>

Postman Collection Item JSON

{
  "name": "Bulk Delete Organizations",
  "request": {
    "method": "DELETE",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/organizations/destroy_many?ids=<string>&external_ids=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "organizations",
        "destroy_many"
      ],
      "query": [
        {
          "key": "ids",
          "value": "<string>",
          "description": "A list of organization ids"
        },
        {
          "key": "external_ids",
          "value": "<string>",
          "description": "A list of external ids"
        }
      ]
    },
    "description": "Accepts a comma-separated list of up to 100 organization ids or external ids.\n\n#### Response\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* Admins\n* Agents assigned to a custom role with permissions to manage organizations (Enterprise only)\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "DELETE",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/organizations/destroy_many?ids=<string>&external_ids=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organizations",
            "destroy_many"
          ],
          "query": [
            {
              "key": "ids",
              "value": "<string>",
              "description": "A list of organization ids"
            },
            {
              "key": "external_ids",
              "value": "<string>",
              "description": "A list of external 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}"
    }
  ]
}