Delete a mail folder
Deletes a folder and everything in it.
DELETE
/v1/folders/:id
Permission
The key must be granted mail.folders.write
A key without it gets 403 insufficient_scope, with the missing permission named in details.
Deletes the folder and every message in it. Nothing moves to Trash first and there is no undo, so move anything worth keeping before calling this.
Path parameters
| Field | Type | Description |
|---|---|---|
id required |
string | The folder to delete. |
Request
curl https://api.veruapis.com/v1/folders/:id \
-X DELETE \
-H "Authorization: Bearer vak_live_..." \
-H "Idempotency-Key: $(uuidgen)"Idempotency-Key is required on every write. Retrying with the same key returns the original response rather than repeating the operation, so a timeout is something you retry rather than something you investigate.
Response
Answers 204.
Returns 204 with no body.
Errors
Every failure uses the same shape, with a stable string code you can branch on. See the error reference.
Related
- POST Create a draft
- POST Create a mail filter
- POST Create a mail folder
- DELETE Delete a draft
- DELETE Delete a mail filter
- DELETE Delete a message
- GET Download an attachment
- GET Get a message
- GET Get display preferences
- GET List attachments
- GET List drafts
- GET List mail filters
- GET List mail folders
- GET List messages
- POST Move messages
- PUT Replace a draft
- POST Send an email
- POST Change flags and labels
- PATCH Rename a mail folder
- PATCH Update display preferences