Skip to main content
DELETE
Delete a folder

Authorizations

X-Public-Key
string
header
required

Public half of the company API key. Format: pk_ followed by 64 hexadecimal characters.

X-Secret-Key
string
header
required

Secret half of the company API key. Format: sk_ followed by 64 hexadecimal characters. Stored as a hash server-side and shown only at creation or rotation.

Path Parameters

folderId
string<uuid>
required

Folder identifier.

Body

application/json
trash
enum<string>
default:soft

Deletion mode.

Available options:
soft,
hard

Response

Folder deleted.

status
integer
required
Example:

200

message
string
required
Example:

"Folder deleted"

data
object | null
required
Example:

null