# Delete a folder

`DELETE https://api.mailmasker.org/api/v1/drive/folders/:id`

Delete a folder and everything inside it, for good or to Trash.

- Who can use it: Any signed-in account
- Area: Drive
- Answers 200 OK when it works
- Page: https://developer.mailmasker.org/drive-delete-folder

Every file and folder inside it goes too, however deep. Unlike the Drive web page, this is immediate and for good; add `soft=1` to move the whole folder to Trash instead, where it can be restored in one go.

## Parameters

| Name | In | Required | What it is | Example |
|---|---|---|---|---|
| `id` | path | yes | The folder's id. | `7` |
| `soft` | query | no | 1 to move the folder to Trash instead of deleting it for good. |  |

## Good to know

- A folder that isn't yours, doesn't exist or is already in Trash answers 404.

## Examples

cURL:

```bash
curl -s -X DELETE 'https://api.mailmasker.org/api/v1/drive/folders/7' \
  -H "Authorization: Bearer $TOKEN"
```

Perl:

```perl
use Mojo::Base -strict;
use Mojo::UserAgent;

my $ua  = Mojo::UserAgent->new;
my $res = $ua->delete('https://api.mailmasker.org/api/v1/drive/folders/7',
    { Authorization => "Bearer $ENV{TOKEN}" })->result;
die $res->code, ' ', ($res->json('/error') // $res->message), "\n" unless $res->is_success;
print $res->body, "\n";
```

homelab-cli:

```bash
homelab-cli drive rmdir 7
```

## Response

200 OK:

```json
{ "ok": true, "trashed": false }
```