---
title: "Delete Domain Mailbox"
method: POST
path: "/provider-domains/{domain_id}/delete-mailbox"
tags: ["Provider Domains"]
---

# Delete Domain Mailbox

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

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/provider-domains/{domain_id}/delete-mailbox`
- Auth: HTTP bearer

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.

## Path parameters

- `domain_id` integer, required: Sending domain id (provider_domains.id) - from GET /provider-domains

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- DomainMailboxRefRequest: 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.
  - `mailbox_id` integer, required: Mailbox id (mailboxes.id) on this domain

## Response `200`

Successful Response

- ApiResponseMailboxDomainPayload
  - `data` MailboxDomainPayload, 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.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)