Zapmail
latest
  • latest
  • v1
  1. mailbox
Zapmail
latest
  • latest
  • v1
  • Zapmail Docs
  • users
    • Retrieve User Details
      GET
  • workspaces
    • Retrieve all workspaces
      GET
    • Create new workspace
      POST
    • Update workspace
      PUT
  • billing
    • Add Billing Details
      POST
    • Update Billing Details
      PUT
  • mailbox
    • Retrieve All Mailboxes
      GET
    • Get Mailbox Details by ID
      GET
    • Assign New Mailboxes to Domains
      POST
    • Update mailbox
      PUT
    • Remove mailboxes on next renewal
      PUT
    • Get Authenticator code
      GET
  • payments & wallet
    • Add balance to wallet
      POST
    • Get wallet balance
      GET
    • Enable auto recharge
      POST
  • export
    • Export mailboxes
      POST
    • Add third party account details
      POST
    • Update third party account details
      PUT
  • subscriptions
    • Get all subscriptions
      GET
    • Cancel subscription
      POST
    • Upgrade existing subscription
      POST
  • domains
    • Retrieve All Domains
    • List Assignable Domains
    • Add DMARC record
    • Add Domain forwarding
    • Get Name servers to connect domain
    • Verify Name Server Propagation
    • Connect Domain with Zapmail
    • Enable email forwarding
    • Remove email forwarding
    • Enable catch all emails
    • Remove catch all emails
    • Check DNS records
    • Remove unused domains
    • Get available domains for registration
    • Get domains purchase payment link
    • Get domain connection requests
    • Remove domain connection requests
    • Connect Domain with Zapmail (New)
  • dns
    • Get dns records
    • Add dns records
    • Update dns records
    • Delete dns records
  1. mailbox

Remove mailboxes on next renewal

PUT
/v2/mailboxes/scheduled-removal

Remove Mailboxes on Next Renewal API#

This endpoint allows you to remove mailboxes on the next renewal.

Body#

mailboxIds#

Type: array
Description: IDs of mailboxes that need to be removed on the next renewal. Leave it empty to remove all mailboxes on the next renewal.

remove#

Type: boolean
Description: Set to true if you want to remove mailboxes on the next renewal and set to false if you want to cancel removal of mailboxes on the next renewal.
Note: Sending empty mailboxIds would result in removal of all the active mailboxes.

Request

Header Params
x-auth-zapmail
string 
required
Example:
{{x-auth-zapmail}}
Body Params application/json
mailboxIds
array[string]
required
remove
boolean 
required
Example
{
    "mailboxIds": [
        "8c710a22-745f-441b-a225-8cd1f8c8f2b1",
        "620b128a-bf3c-4219-a326-404983140fdd",
        "7dff34a9-fbe5-47dd-8864-4aa13fcf85e1",
        "6dc1cd71-a91d-4afc-ab56-48a7e9b22b75",
        "bf4c4a42-b700-4fe9-aa09-57f2dbd8d5c8",
        "e1389587-a124-4a14-a535-026f3f0854c9",
        "53bdd3fa-cb18-47f5-bb70-ec8adb97779d"
    ],
    "remove": true
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.zapmail.ai/api/v2/mailboxes/scheduled-removal' \
--header 'x-auth-zapmail: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mailboxIds": [
        "8c710a22-745f-441b-a225-8cd1f8c8f2b1",
        "620b128a-bf3c-4219-a326-404983140fdd",
        "7dff34a9-fbe5-47dd-8864-4aa13fcf85e1",
        "6dc1cd71-a91d-4afc-ab56-48a7e9b22b75",
        "bf4c4a42-b700-4fe9-aa09-57f2dbd8d5c8",
        "e1389587-a124-4a14-a535-026f3f0854c9",
        "53bdd3fa-cb18-47f5-bb70-ec8adb97779d"
    ],
    "remove": true
}'

Responses

🟢200Success
application/json
Body
object {0}
Example
{
    "message": "Mailbox will be removed on next renewal",
    "data": null
}
Modified at 2025-06-27 07:35:42
Previous
Update mailbox
Next
Get Authenticator code
Built with