Chilkat Online Tools

Mono / Postman API / Delete Collection

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

http.SetRequestHeader("X-API-Key","{{postman_api_key}}");

Chilkat.HttpResponse resp = http.QuickRequest("DELETE","https://api.getpostman.com/collections/{{collection_uid}}");
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

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

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("Failed.");

    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "collection": {
//     "id": "a14c6da7-afba-4a84-bf22-4febbaaced6c",
//     "uid": "5852-a14c6da7-afba-4a84-bf22-4febbaaced6c"
//   }
// }

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

string Id = jResp.StringOf("collection.id");
string Uid = jResp.StringOf("collection.uid");

Curl Command

curl -X DELETE
	-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/collections/{{collection_uid}}

Postman Collection Item JSON

{
  "name": "Delete Collection",
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "pm.test(\"response is ok\", function () {",
          "    pm.response.to.have.status(200);",
          "});",
          "",
          "pm.test(\"response json data should not have errors\", function () {",
          "    pm.response.to.have.jsonBody();",
          "    pm.response.to.not.have.jsonBody('error');",
          "});",
          "",
          "pm.test(\"response json should contain one collection\", function () {",
          "    pm.expect(pm.response.json()).to.have.property('collection').and.be.an('object');",
          "});",
          "",
          "pm.test(\"response json should return collection details\", function () {",
          "    pm.expect(pm.response.json()).to.have.property('collection')",
          "        .and.to.include.keys(['id', 'uid']);",
          "});",
          "",
          "// additional tests to ensure that the relevant environment variables are present",
          "pm.test('\"postman_api_key\" variable should be present', function () {",
          "    pm.expect(pm.variables.get('postman_api_key')).to.be.a('string');",
          "});"
        ]
      }
    }
  ],
  "request": {
    "method": "DELETE",
    "header": [
    ],
    "url": {
      "raw": "https://api.getpostman.com/collections/{{collection_uid}}",
      "protocol": "https",
      "host": [
        "api",
        "getpostman",
        "com"
      ],
      "path": [
        "collections",
        "{{collection_uid}}"
      ]
    },
    "description": "This endpoint allows you to delete an existing collection.\n\nOn successful deletion of the collection, the response returns the `id` and `uid`.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
  },
  "response": [
    {
      "name": "Collection Not Found",
      "originalRequest": {
        "method": "DELETE",
        "header": [
        ],
        "url": {
          "raw": "https://api.getpostman.com/collections/{{collection_uid}}",
          "protocol": "https",
          "host": [
            "api",
            "getpostman",
            "com"
          ],
          "path": [
            "collections",
            "{{collection_uid}}"
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json",
          "name": "Content-Type",
          "description": {
            "content": "",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"error\": {\n        \"name\": \"instanceNotFoundError\",\n        \"message\": \"The specified item does not exist.\",\n        \"details\": {\n            \"item\": \"collection\",\n            \"id\":\"a14c6da7-afba-4a84-bf22-4febbaaced6c\"\n        }\n    }\n}"
    },
    {
      "name": "Collection Deleted",
      "originalRequest": {
        "method": "DELETE",
        "header": [
        ],
        "url": {
          "raw": "https://api.getpostman.com/collections/{{collection_uid}}",
          "protocol": "https",
          "host": [
            "api",
            "getpostman",
            "com"
          ],
          "path": [
            "collections",
            "{{collection_uid}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json",
          "description": {
            "content": "",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"collection\": {\n        \"id\": \"a14c6da7-afba-4a84-bf22-4febbaaced6c\",\n        \"uid\": \"5852-a14c6da7-afba-4a84-bf22-4febbaaced6c\"\n    }\n}"
    }
  ]
}