Deliverability

Get 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.

get/deliverability/capacity-plan

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/deliverability/capacity-plan
  • Auth: HTTP bearer

Query parameters

contacts_per_monthinteger required

Volume you intend to send per month.

delivery_daysinteger

Days you want to spread that volume over.

warmedboolean

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

domain_tldstring

Extension to price against.

exclude_committedboolean

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

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataMailboxDomainPayload 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.