---
title: "Archive Mailbox"
method: POST
path: "/mailboxes/{mailbox_id}/archive"
tags: ["Mailboxes"]
---

# Archive Mailbox

`POST /mailboxes/{mailbox_id}/archive`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/mailboxes/{mailbox_id}/archive`
- Auth: HTTP bearer

Archive a mailbox, or restore it. Explicit rather than a toggle.

Archiving hides the mailbox from pickers so nothing new is attached to it;
it is not deleted, keeps its history, and `is_archived=false` brings it
back. It does not cancel a purchased mailbox's billing - that is
`request-cancellation`.

Needs a personal API key whose user holds a mailbox write permission.

## Path parameters

- `mailbox_id` integer, required: Mailbox id (mailboxes.id)

## Headers

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

## Request body

- MailboxArchiveRequest: Archive a mailbox, or bring it back. Mirrors the app's `ArchiveMailboxRequest`.
  - `is_archived` boolean, required: True hides the mailbox from pickers and stops new use; false restores it

## 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/89fc11143b70?raw)