Skip to content

List Eligible Domains

GET
/mailboxes/schedule-buy/eligible-domains

The organisation’s domains a REUSE plan would adopt. SPENDS NOTHING.

Owned, live, usable, transfer-free, with FEWER live mailboxes than mailboxes_per_domain (partly filled domains are topped up), not already claimed by another active plan, and connected to the mail service when sourced externally. Each row carries existing_mailboxes and missing_mailboxes. It is the same predicate the lock enforces, so the list cannot disagree with a lock. Capped at the lock’s own limit (500); truncated says the organisation owns more.

Authorizations

Parameters

Query Parameters

mailboxes_per_domain

The plan’s mailboxes per domain; a domain qualifies while it has fewer live mailboxes.

integer
default: 3 >= 1 <= 5

The plan’s mailboxes per domain; a domain qualifies while it has fewer live mailboxes.

Header Parameters

X-Target-Org-Id
Any of:
string

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