Provider Domains

Checkout Purchase Mailboxes

Buy one or more mailboxes on a domain. SPENDS REAL CREDITS — unrestricted, same as the app; there is no per-key spend cap.

Send an Idempotency-Key header to make a retry safe. Returns 402 if the credit hold can't clear, 422 if the org's plan can't fund a purchase at all, 400 for an unconnected/wrong-platform domain, too many mailboxes, or a missing username, 404 if domain_id doesn't belong to this org.

post/provider-domains/{domain_id}/checkout-mailboxes

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/provider-domains/{domain_id}/checkout-mailboxes
  • Auth: HTTP bearer

Path parameters

domain_idinteger required

Provider domain ID (provider_domains.id) — from GET /provider-domains

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

enable_warmupboolean

Enroll each mailbox in warmup immediately after purchase

warmup_settingsobject nullable
provider'registrar' | 'managed' | 'pilot'
platform'GOOGLE' | 'MICROSOFT' nullable

Mailbox platform. Required when provider='managed'.

warmup_engine'instantly' | 'smartlead' | 'managed' nullable

Warmup engine. Omit to use the account default.

Response

Successful Response

dataobject required

Changes

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