> For the complete documentation index, see [llms.txt](https://docs.apica.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apica.io/platform-docs/test-data-orchestrator-tdo/user-documentation/api-guide/workset-apis/delete-workset.md).

# Delete Workset

This API deletes an existing workset. As the workset ID is passed in the URL, you can only delete one workset at a time. It is run as a DELETE call. This API can only be run by a user with Admin privileges; all other users will get a return message that they do not have proper authorization to perform this function.

<figure><img src="https://2948796384-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LmzGprckLqwd5v6bs6m%2Fuploads%2F5zQS9QrkpACjmoHINqKa%2Fimage.png?alt=media&amp;token=1f7ee529-b877-4b6e-8ff0-0ca5e0b21d6a" alt=""><figcaption><p>Delete workset API</p></figcaption></figure>

The body is the same body as the other simple calls (other than ‘create’ and ‘update’).

```
 {
    "context": {
        "user": "mbj_test",
        "password": "xxxx",
        "project": {
            "name": "imp_payments_demo",
            "version": "1.0"
        }
    }
}
```

Here is the workset listing prior to running this call. The ID in the call URL is for the ‘cloned\_workset’.

<figure><img src="https://2948796384-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LmzGprckLqwd5v6bs6m%2Fuploads%2FcVH9WzzST1qt9uIeHQPc%2Fimage.png?alt=media&amp;token=cc2dbe68-ecdb-482b-8bf3-b8de8d6cd1f4" alt=""><figcaption><p>Workset list from TDO</p></figcaption></figure>

When run, the response contains the result (‘0’ for false and ‘1’ for true). A response of ‘1’ indicates that the workset has been deleted.

<figure><img src="https://2948796384-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LmzGprckLqwd5v6bs6m%2Fuploads%2FCcNbqoYsuzP37wXNpM7e%2Fimage.png?alt=media&amp;token=89a64adb-8a38-42fb-83c3-4ef861364a89" alt=""><figcaption><p>Results message for delete workset API</p></figcaption></figure>

When viewing the workset listing in TDO, the workset ‘cloned\_workset’ is no longer present.

<figure><img src="https://2948796384-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LmzGprckLqwd5v6bs6m%2Fuploads%2Fal0DTH2ULwmG3ZrQAm5I%2Fimage.png?alt=media&amp;token=62be3b5a-0cc5-48bf-ab7c-423138a45d70" alt=""><figcaption><p>TDO workset list showing successful deletion</p></figcaption></figure>
