Skip to main content
POST
Batch delete mailbox messages

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.

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.

Body

application/json
ids
string[]
required

Message IDs to delete, maximum 100.

Required array length: 1 - 100 elements
if_in_state
string

Optional message state token for stale-write protection.

permanent
boolean

When true, permanently deletes instead of moving to Trash.

Response

Batch delete result

meta
object
required
ok
enum<boolean>
required
Available options:
true
data
object
required