Skip to content

Delete Domain Mailbox

POST
/provider-domains/{domain_id}/delete-mailbox

Delete a mailbox at the provider. NOT REVERSIBLE.

The mailbox stops existing upstream and its mail goes with it. Different from DELETE /mailboxes/{mailbox_id}, which removes graph8’s record of a mailbox and leaves the provider’s copy alone. A domain’s admin mailbox cannot be deleted - it is what manages the domain.

To stop paying for a purchased mailbox without destroying it, use POST /mailboxes/{mailbox_id}/request-cancellation instead.

Authorizations

Parameters

Path Parameters

domain_id
required

Sending domain id (provider_domains.id) - from GET /provider-domains

integer

Sending domain id (provider_domains.id) - from GET /provider-domains

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Names one mailbox on the domain in the path.

Shared by the info / TOTP / delete / status routes, all of which read request["mailbox_id"] off an untyped dict in the app.

object
mailbox_id
required

Mailbox id (mailboxes.id) on this domain

integer
> 0

Responses

200

Successful Response

object
data
required

An open envelope for one provider/deliverability result.

Open on purpose. These payloads are provider state and advisory reads whose contents grow with the product, and a dropped field reads as “nothing to report” rather than “we did not tell you”. Every value passes through scrub_vendor_names on the way in.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string