Skip to content

Get Capacity Plan

GET
/deliverability/capacity-plan

How much sending capacity a target volume needs, and what the shortfall costs.

RECOMMENDATION ONLY. It buys nothing and holds nothing - the credit figure it returns is an estimate of what closing the gap WOULD cost. The buying is POST /mailboxes/schedule-buy/plans, which is a separate, deliberate act.

Authorizations

Parameters

Query Parameters

contacts_per_month
required

Volume you intend to send per month.

integer
<= 100000000

Volume you intend to send per month.

delivery_days

Days you want to spread that volume over.

integer
default: 30 >= 1 <= 365

Days you want to spread that volume over.

warmed

Assume new mailboxes must warm up before they count as capacity.

boolean
default: true

Assume new mailboxes must warm up before they count as capacity.

domain_tld

Extension to price against.

string
default: .com /^\.[a-z]{2,10}$/

Extension to price against.

exclude_committed

Treat the target as ADDITIONAL volume: mailboxes already in live sequences are not capacity.

boolean

Treat the target as ADDITIONAL volume: mailboxes already in live sequences are not capacity.

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