Files
cloudflare_temp_email/vitepress-docs/docs/en/guide/feature/delete-address.md
2026-04-04 18:33:56 +08:00

842 B

Delete Address API

Admin Delete Address API

Delete an address by address ID. This endpoint requires admin auth and deletes related data (mails, sender settings, bindings, etc.).

DELETE /admin/delete_address/:id

Header:

  • x-admin-auth: <admin_password>

Example response:

{ "success": true }

User Delete Address API

Delete mailbox by address JWT. The request needs address token permission and deletes related data (received mails, sent items, auto reply data, sender bindings, user bindings, telegram bind records).

DELETE /api/delete_address

Headers:

  • Authorization: Bearer <address_jwt>

Notes:

  • ENABLE_USER_DELETE_EMAIL must be enabled.
  • Address credential can be obtained from /api/new_address or /admin/new_address.

Example response:

{ "success": true }