Skip to content

Check Plan Domains

POST
/mailboxes/schedule-buy/check-domains

Validate names you edited: already yours, available, or refused. SPENDS NOTHING.

One entry per name. available: null means the probe itself failed and the answer is UNKNOWN - not that the name is taken. Treat null as “check again” rather than as a no.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Validate edited candidate names: owned-by-you, and available. SPENDS NOTHING.

object
names
required

Domain names to validate

Array<string>
>= 1 items <= 100 items

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

A named collection ({"plans": [...]}) keeps its own key AND gains items, so a caller can page every list surface the same way without memorising which key each route chose.

object
items
Array
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