InboxKit
  1. Mailboxes
InboxKit
  • Introduction
  • Account
    • Get account details
      GET
  • Workspaces
    • List workspaces
      GET
    • Get workspace details
      GET
    • Create workspace
      POST
    • Update workspace
      PUT
    • Delete workspace
      DELETE
    • Update workspace webhook
      POST
  • Domains
    • Search available domains
      POST
    • Check if domain is banned from registration
      GET
    • Check domain availability
      GET
    • Register domains
      POST
    • List domains
      GET
    • List assignable domains
      GET
    • Set DMARC policy
      POST
    • Remove DMARC policy
      DELETE
    • Remove domains
      POST
    • Set domain forwarding
      POST
    • Set email forwarding
      POST
    • Remove email forwarding
      DELETE
    • Set catch-all email
      POST
    • Remove catch-all email
      DELETE
    • Get nameservers for domain connection
      POST
    • Check nameservers propagation
      POST
  • Mailboxes
    • List mailboxes
      GET
    • Show mailbox credentials
      GET
    • Get mailbox details
      GET
    • Buy mailboxes
      POST
    • Check mailbox status
      POST
    • Cancel mailboxes
      POST
    • Update mailbox
      POST
    • Update mailbox profile picture
      POST
    • Generate TOTP
      GET
    • Change username
      POST
    • Change password
      POST
    • Check mailbox availability
      GET
  • DNS
    • Get DNS records
    • Add DNS records
    • Update DNS records
    • Delete DNS records
  • Sequencers
    • Export mailboxes status
    • List sequencer platforms
    • List sequencers
    • Export mailboxes
    • Add sequencer
    • Update sequencer
    • Delete sequencers
  • Billing
    • Get pricing plans
    • Get subscription details
    • Change subscription plan
    • Cancel subscription
    • Get wallet details
    • Add credits to wallet
    • Update auto top-up settings
    • Get billing portal link
  1. Mailboxes

Cancel mailboxes

POST
https://api.inboxkit.com/v1/api/mailboxes/cancel
Mailboxes
Maintainer:Not configured
Schedule specified mailboxes for cancellation
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.inboxkit.com/v1/api/mailboxes/cancel' \
--header 'X-Workspace-Id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uids": [
        "string"
    ],
    "domain_uids": [
        "string"
    ]
}'
Response Response Example
{
    "error": false,
    "message": "Mailbox scheduled for cancellation"
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params
X-Workspace-Id
string <uuid>
required
Workspace identifier
Body Params application/json
uids
array[string]
required
Mailbox UIDs to cancel
domain_uids
array[string]
optional
Examples

Responses

🟢200OK
application/json
Mailboxes scheduled for cancellation
Body
error
boolean 
optional
Example:
false
message
string 
optional
Example:
Mailbox scheduled for cancellation
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Modified at 2025-06-20 08:05:49
Previous
Check mailbox status
Next
Update mailbox
Built with