Delete a custom status by ID
DELETE
/statuses/{statusId}Deletes a custom status. System statuses cannot be deleted. Project context might be required.
Example
Section titled “Example”Use resource IDs from your own project. Keep the API token in your server or CI environment.
import { createConfiguration, StatusesApi } from '@testcollab/sdk';
const config = createConfiguration(process.env.TESTCOLLAB_TOKEN!);const api = new StatusesApi(config);
const result = await api.deleteStatusById({ "statusId": 0});console.log(result);curl --request DELETE \ "https://api.testcollab.io/statuses/123?token=$TESTCOLLAB_TOKEN"Parameters
Section titled “Parameters”| Name | Location | Type | Required | Description |
|---|---|---|---|---|
statusId |
path | integer | Yes | ID of the custom status to delete. |
project |
query | integer | No | ID of the project for context (if status is project-specific and needs auth check). |
Response
Section titled “Response”A successful response confirms that the operation was accepted. Use the resource read methods to confirm the final state of asynchronous changes.
Errors
Section titled “Errors”| Status | Meaning |
|---|---|
400 |
Bad request - Cannot delete a system status. |
401 |
Unauthorized - Authentication required |
403 |
Forbidden - User does not have permission to delete this status |
404 |
Status not found |