Delete suite

DELETE/suites/{id}

Moves a suite and its active sub-suites and cases, including archived cases, to the project’s Trash for 60 days (). Existing delete permissions and eligibility checks still apply. The subtree acts as deleted in ordinary reads, while its data and linked copies remain available for company Administrator restoration. Items already in Trash retain their own entries and expiry times. Project deletion and BDD sync archival are unchanged.

Example

Use resource IDs from your own project. Keep the API token in your server or CI environment.

TypeScript SDK

example.ts

import { createConfiguration, SuitesApi } from '@testcollab/sdk';

const config = createConfiguration(process.env.TESTCOLLAB_TOKEN!);
const api = new SuitesApi(config);

const result = await api.deleteSuite({
  "project": 123,
  "id": 123
});
console.log(result);

HTTP

curl --request DELETE \
  "https://api.testcollab.io/suites/123?token=$TESTCOLLAB_TOKEN&project=123"

Parameters

Name	Location	Type	Required	Description
project	query	number	Yes	Project ID
id	path	number	Yes	Suite ID

Response

200 — Suite deleted

Illustrative response

{}

Errors

Status	Meaning
403	Forbidden

Next steps

• Browse cases and suites
• Authentication
• Handle errors