Skip to content

Suggest Plan

POST
/mailboxes/schedule-buy/suggest

Size a plan before you lock it. SPENDS NOTHING, holds nothing.

Counts the idle mailboxes you already have, then works out how many new domains and mailboxes the target volume still needs and what they would cost in credits. Pass its idle count back as idle_mailboxes_snapshot when you lock the plan.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Size a plan for a target volume: idle capacity, net-new domains and mailboxes, credit cost. SPENDS NOTHING. Mirrors the app’s SuggestRequest field for field.

object
daily_send_cap

Sends per mailbox per day

integer
default: 15 >= 1 <= 100
domains_per_batch

Domains bought per daily batch

integer
default: 10 >= 1 <= 100
google_share_pct

Google Workspace share of the plan when platform=‘mixed’

integer
default: 100 <= 100
mailboxes_per_domain

Mailboxes bought on each domain

integer
default: 3 >= 1 <= 5
platform

Mailbox platform to price. ‘mixed’ splits by google_share_pct

string
default: google
Allowed values: google microsoft mixed
reuse_domain_count
Any of:
integer
>= 1 <= 500
reuse_missing_mailboxes
Any of:
integer
>= 1 <= 2500
sending_days_per_month

Sending days assumed per month

integer
default: 22 >= 1 <= 31
target_monthly_volume
required

Contacts you intend to reach per month

integer
<= 100000000
warmup_enabled

Price the premium-pool warmup hold per mailbox on top of the base cost

boolean
default: true

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