Skip to content

Suggest Plan Domains

POST
/mailboxes/schedule-buy/suggest-domains

Candidate domain names a plan WOULD buy. SPENDS NOTHING, buys nothing.

Same generator, same owned-domain exclusion and same live availability probe the executor uses at buy time, so the preview is honest rather than decorative.

offset rotates the generator: call again with a higher offset to get a fresh set instead of the same list. avoid excludes names you have already rejected.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Preview the domain names a plan WOULD buy. SPENDS NOTHING.

object
avoid
Any of:
Array<string>
<= 50 items
count
required

How many candidate names to return

integer
>= 1 <= 100
domain_tld

Extension to generate against, e.g. ‘.com’

string
default: .com
offset

Rotate the generator to get fresh candidates

integer
<= 1000
pattern
Any of:
string
Allowed values: prefix suffix both
roots
Any of:
Array<string>
<= 10 items
tlds
Any of:
Array<string>
>= 1 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