Skip to content

Uncancel Mailboxes

POST
/mailboxes/uncancel

Undo a scheduled cancellation. RESUMES BILLING on every mailbox listed.

Bulk by design; pass one id for a single undo. Idempotent - a mailbox that is already active is a no-op success rather than an error.

Read the per-id breakdown in results, not the HTTP status: a mailbox that could not be restored is REPORTED, and the request still returns 200 with the ones that were.

422 for an org without an active or pre-funded plan. A churned org must not resume mailbox billing, and restoring one would be re-cancelled within days anyway.

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

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Reverse a scheduled cancellation. RESUMES BILLING on every mailbox listed.

object
mailbox_ids
required

Mailboxes to restore. Up to 50.

Array<integer>
>= 1 items <= 50 items

Responses

200

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string