Chilkat Online Tools

phpAx / Squadcast API V3 / Delete Squad

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';

// resp is a Chilkat.HttpResponse
$resp = $http->QuickRequest('DELETE','https://api.squadcast.com/v3/squads/:squadID');
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode != 204) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Response Body:' . "\n";
    print $resp->BodyStr . "\n";
    print 'Failed.' . "\n";

    exit;
}

print 'Success.' . "\n";

?>

Curl Command

curl -X DELETE
	-H "Authorization: Bearer <access_token>"
https://api.squadcast.com/v3/squads/:squadID

Postman Collection Item JSON

{
  "name": "Delete Squad",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{sq_pb_auth_header}}",
          "type": "string"
        }
      ]
    },
    "method": "DELETE",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/squads/:squadID",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "squads",
        ":squadID"
      ],
      "variable": [
        {
          "key": "squadID",
          "value": "5ed4e5977cc8a1daa90d56eb",
          "type": "string"
        }
      ]
    },
    "description": "This endpoint is used to delete the squad. Squad should be assigned to any incident or part of any escalation policy.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `squad-update` scope."
  },
  "response": [
    {
      "name": "204 No Content",
      "originalRequest": {
        "method": "DELETE",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/squads/:squadID",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "squads",
            ":squadID"
          ],
          "variable": [
            {
              "key": "squadID",
              "value": "5ed4e5977cc8a1daa90d56eb"
            }
          ]
        }
      },
      "status": "No Content",
      "code": 204,
      "_postman_previewlanguage": "json",
      "header": null,
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "401 Unauthorized",
      "originalRequest": {
        "method": "DELETE",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/squads/:squadID",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "squads",
            ":squadID"
          ],
          "variable": [
            {
              "key": "squadID",
              "value": "5ed4e5977cc8a1daa90d56eb"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": null,
      "cookie": [
      ],
      "body": "{\n    \"meta\": {\n        \"status\": 401,\n        \"error_message\": \"<string>\"\n    }\n}"
    },
    {
      "name": "403 Forbidden",
      "originalRequest": {
        "method": "DELETE",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/squads/:squadID",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "squads",
            ":squadID"
          ],
          "variable": [
            {
              "key": "squadID",
              "value": "5ed4e5977cc8a1daa90d56eb"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": null,
      "cookie": [
      ],
      "body": "{\n    \"meta\": {\n        \"status\": 403,\n        \"error_message\": \"<string>\"\n    }\n}"
    },
    {
      "name": "404 Not Found",
      "originalRequest": {
        "method": "DELETE",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/squads/:squadID",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "squads",
            ":squadID"
          ],
          "variable": [
            {
              "key": "squadID",
              "value": "5ed4e5977cc8a1daa90d56eb"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": null,
      "cookie": [
      ],
      "body": "{\n    \"meta\": {\n        \"status\": 404,\n        \"error_message\": \"<string>\"\n    }\n}"
    },
    {
      "name": "500 Internal Server Error",
      "originalRequest": {
        "method": "DELETE",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/squads/:squadID",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "squads",
            ":squadID"
          ],
          "variable": [
            {
              "key": "squadID",
              "value": "5ed4e5977cc8a1daa90d56eb"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": null,
      "cookie": [
      ],
      "body": "{\n    \"meta\": {\n        \"status\": 500,\n        \"error_message\": \"<string>\"\n    }\n}"
    }
  ]
}