Skip to main content
POST
Preview pool domains

Authorizations

Authorization
string
header
default:Bearer pk_test_<your-test-key>
required

Partner API key (pk_live_… or pk_test_…).

Body

application/json
domain_count
integer
required
Required range: 1 <= x <= 500
requires_forwarding
boolean

When true, preview only domains with exactly two physical inboxes.

Response

Complete soft preview.

data
object
required
Last modified on August 25, 2026