Delete a mailbox folder

curl --request DELETE \
  --url https://app.sendmux.ai/api/v1/mailbox/folders/{folder_id} \
  --header 'Authorization: Bearer <token>'

{
  "ok": true,
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "deleted": true,
    "id": "<string>"
  }
}

DELETE

mailbox

folders

{folder_id}

Delete a mailbox folder

curl --request DELETE \
  --url https://app.sendmux.ai/api/v1/mailbox/folders/{folder_id} \
  --header 'Authorization: Bearer <token>'

{
  "ok": true,
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "deleted": true,
    "id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Headers

If-Match

string

Path Parameters

folder_id

string

required

Query Parameters

mailbox_id

string

Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.

Response

Deletion result

enum<boolean>

required

Available options:

true