Mailboxes

Archive Mailbox

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.

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

Path parameters

mailbox_idinteger required

Mailbox id (mailboxes.id)

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

is_archivedboolean required

True hides the mailbox from pickers and stops new use; false restores it

Response

Successful Response

dataMailboxDomainPayload 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.

Changes

No recorded changes to this operation across all 3 revisions of this API.