Peeker Partner API

Use a swap to replace one domain without changing the workspace target, customer tracking, or rest of the order. Full rules: How swaps work.

Type	Behavior
`standard`	Retires the old domain during cutover
`premium`	Keeps the old domain warm for 14 days while the replacement warms

Premium is Microsoft only, with a rolling 30-day seat quota (Partner accounts: VIP+ 30% of active Microsoft licenses) and a 30-day cooldown per seat. Premium replacements must already have been bought through Peeker. Use standard for Google or imported domains. Before creating either kind of swap, the replacement must be available in your Peeker inventory with an active Peeker-managed Cloudflare zone. It must be unattached or in the source workspace. This endpoint does not buy or import a missing replacement domain.

Submit a swap

curl -X POST "https://api.peeker.ai/partner/v1/swaps" \
  -H "Authorization: Bearer pk_test_<your-key>" \
  -H "Idempotency-Key: swap_acme_001" \
  -H "Content-Type: application/json" \
  --data '
{
  "type": "premium",
  "domain_id": "dom_01HZX0D01A2B3C4D5E6F7G8H",
  "replacement_domain": "acme-fresh.com"
}'

{
	"data": {
		"id": "swp_01HZX0SW1A2B3C4D5E6F7G8H",
		"type": "premium",
		"domain_id": "dom_01HZX0D01A2B3C4D5E6F7G8H",
		"replacement_domain": "acme-fresh.com",
		"status": "created",
		"created_at": "2026-05-08T12:00:00Z"
	}
}

Send an Idempotency-Key on both /swaps and /swaps/user_names. After a timeout or server error, retry with the same key and unchanged body to recover the original creation result. Poll its swap ID for current progress. Reusing a key with different parameters returns 409 idempotency_conflict. If the original request is still running, retry 409 idempotency_in_progress with backoff. Keys are unique across your Partner account. The header is optional for existing integrations. Without it, the API cannot replay the original creation response; check GET /swaps before submitting again. A distinct second swap on a seat that already has one in flight returns 400 invalid_request.

Track the swap

Poll GET /swaps/{id} or subscribe to swap events.

swap.created → swap.in_progress → swap.completed
                              ↘ swap.failed

To keep the domain and change mailbox identities, use Rename inbox senders.

​Submit a swap

​Track the swap

Submit a swap

Track the swap