> 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="/files/DdqiJ4zZVzWsAxE05nnF" alt=""><figcaption><p>Delete workset API</p></figcaption></figure>

&#x20;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"
        }
    }
}
```

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

&#x20;

<figure><img src="/files/IWNeJ7EkK9ike8755Mqt" alt=""><figcaption><p>Workset list from TDO</p></figcaption></figure>

&#x20;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.

&#x20;

<figure><img src="/files/BLWBayraT2HPmFH9ko3z" 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.

&#x20;

<figure><img src="/files/JjuF6iOLd2YXqVrMKXnM" alt=""><figcaption><p>TDO workset list showing successful deletion</p></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.apica.io/platform-docs/test-data-orchestrator-tdo/user-documentation/api-guide/workset-apis/delete-workset.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
