Chilkat Online Tools

PHP (Extension) / Support API / Delete Resource Collection

Back to Collection Items

<?php

include("chilkat_9_5_0.php");

$http->put_BasicAuth(true);$http->put_Login('login');$http->put_Password('password');$resp->GetBodySb($sbResponseBody);$jResp->LoadSb($sbResponseBody);$jResp->put_EmitCompact(false);$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/resource_collections/:resource_collection_id

Postman Collection Item JSON

{
  "name": "Delete Resource Collection",
  "request": {
    "method": "DELETE",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/resource_collections/:resource_collection_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "resource_collections",
        ":resource_collection_id"
      ],
      "variable": [
        {
          "key": "resource_collection_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Deletes a specified resource collection.\n\nThe response includes a [job\nstatus](/api-reference/ticketing/ticket-management/job_statuses/) for deletion of the collection's resources.\n\n#### Allowed for\n\n* Admins\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/resource_collections/:resource_collection_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "resource_collections",
            ":resource_collection_id"
          ],
          "variable": [
            {
              "key": "resource_collection_id"
            }
          ]
        }
      },
      "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}"
    }
  ]
}