Sign in
Mailbox API

Batch delete mailbox messages

Changed on

Moves up to 100 messages to Trash by default with state-safe conflict handling. Set permanent=true to permanently delete them.

post/mailbox/messages:batch-delete

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailbox/messages:batch-delete
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: mailbox.settings.update)

Query parameters

mailbox_idstring

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.

Request body

idsstring[] required

Message IDs to delete, maximum 100.

if_in_statestring

Optional message state token for stale-write protection.

permanentboolean

When true, permanently deletes instead of moving to Trash.

Response

Batch delete result

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

Changes