Mailboxes

Request Mailbox Cancellation

Stop paying for a purchased mailbox. STOPS SPEND; eventually destroys it.

Two steps, and this is the first: the mailbox is scheduled for cancellation at the provider and keeps working until its current period ends. A poller then flips it to cancelled, after which DELETE /mailboxes/{mailbox_id} removes graph8's record of it.

Reversible with POST /mailboxes/uncancel while it is still scheduled - which resumes billing.

422 for a mailbox that was not purchased through graph8, or one already in the cancellation flow. 502 if the provider refused - read that as "nothing was cancelled", not as a partial success.

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

post/mailboxes/{mailbox_id}/request-cancellation

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/mailboxes/{mailbox_id}/request-cancellation
  • Auth: HTTP bearer

Path parameters

mailbox_idinteger required

Mailbox id (mailboxes.id)

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

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 2 revisions of this API.