Mailbox API

Delete a mailbox message

Changed on

Moves a message to Trash by default, unconditionally unless If-Match is supplied. Set permanent=true to permanently delete it. Send If-Match with a prior ETag to reject stale deletes.

delete/mailbox/messages/{message_id}

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailbox/messages/{message_id}
  • 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)

Path parameters

message_idstring required

Query parameters

permanentboolean
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.

Headers

If-Matchstring

Response

Deletion result

oktrue required

Example response

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

Changes