Skip to content

Undo Mailbox Retirement

POST
/deliverability/recovery/undo

Reverse an approved retirement while its grace window is open.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
short_code
required

The retirement’s 4-character code.

string
/^[A-HJ-NP-Za-hj-np-z2-9]{4}$/

Responses

200

Successful Response

object
data
required

The recovery overview, a decision outcome, or a removal request.

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