Archive Mailbox
POST /mailboxes/{mailbox_id}/archive
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.
Authorizations
Parameters
Path Parameters
Mailbox id (mailboxes.id)
Mailbox id (mailboxes.id)
Header Parameters
Request Body required
Archive a mailbox, or bring it back. Mirrors the app’s ArchiveMailboxRequest.
object
True hides the mailbox from pickers and stops new use; false restores it
Responses
200
Successful Response
object
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
object
Whether there are more pages
Items per page
Current page number (1-indexed)
Total number of items
422
Validation Error