Skip to main content
POST
Buy prewarmed domains

Authorizations

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

Partner API key (pk_live_… or pk_test_…).

Headers

Idempotency-Key
string
required

Required for order creation. Pool attach also supports this header for durable retries. Workspace creation does not use it. The value is unique across the Partner account. Reuse it only with the same endpoint and unchanged request body. When retrying an Instantly order after 422 provider_login_credentials_required, you may add or replace only destination.login_credentials; every other field must stay unchanged. For a Smartlead Microsoft order with that error, repair the target through POST /workspaces, then retry the unchanged order with the same key. Retry 503 provider_unavailable or 500 internal_error with the same key and unchanged body. After pool attach returns 409 insufficient_inventory, wait for pool inventory to be replenished, then retry the unchanged body with the same key. After 422 provider_login_credentials_required or 422 provider_credentials_invalid, repair the target workspace, then retry the unchanged body with the same key.

Required string length: 1 - 256

Body

application/json
destination
object
required
domains
string[]
required

Domains from GET /prewarmed, each once. Google and Microsoft domains can be mixed.

Required array length: 1 - 25 elements
Maximum string length: 253

Response

First month charged and the order created. Setup continues in the background; follow data.id with GET /orders/{id}. Retries with the same key return this same order.

data
object
required