Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.peeker.ai/llms.txt

Use this file to discover all available pages before exploring further.

Quickstart

First end-to-end call in five steps. Sandbox, no billing.

API reference

Every endpoint with playground prefill and curl examples.
One POST /orders provisions everything
curl -X POST "https://api.peeker.ai/api/partner/v1/orders" \
  -H "Authorization: Bearer pk_test_…" \
  -H "Content-Type: application/json" \
  --data '
{
  "user": {
    "email": "alex@acme.com",
    "first_name": "Alex",
    "last_name": "Rivera"
  },
  "sequencer": {
    "provider": "smartlead",
    "client_id": 366903,
    "login_email": "peeker@yourcompany.com",
    "login_password": "<your-dedicated-login>"
  },
  "bundle_id": "bun_01HZX0BU1A2B3C4D5E6F7G8H",
  "domains": [
    "acme-mail.com"
  ],
  "users": [
    {
      "first_name": "Alex",
      "last_name": "Rivera"
    }
  ]
}'
# → 200 OK · order.in_progress now, order.completed within 24h

​
What you can do

Users & routing

Create users with provider client routing, or let POST /orders create/reuse the user from email.

Google & Microsoft orders

One POST /orders provisions domains, licenses, inbox names, and forwarding end-to-end.

Domain inventory

Users can connect owned domains via Cloudflare, or buy from your registrar inventory — same order shape.

Swaps & renames

Standard or premium domain swaps; rename users on a domain without losing warmup; full status webhooks.

Pending actions

Orders, domains, imports, and swaps surface action_required when they need partner or customer input.

Bundles

Pick the monthly sending volume once. Peeker resolves the right license mix behind one bundle_id.

​
You ship · we handle

You ship

  • Your customer-facing UI and onboarding. - One POST /orders per purchase. - A signed webhook listener. - Your billing and support.

We handle

  • Domain registration, DNS, forwarding. - Google Workspace + Microsoft 365 provisioning. - Provider routing and upload. - Deliverability monitoring + self-healing swaps.

​
Read these next

Authentication

Bearer keys, sandbox vs live, request IDs, key rotation.

Webhooks

Signed event delivery for every async job. Verify, retry, dedupe.

Best practices

Errors, paging, idempotency, pending actions, handler hygiene.

​
Browse the guides

Quickstart

First end-to-end call in five steps.

Buying domains & ordering

The default flow — bundle, availability, order, webhooks.

Importing domains & ordering

Use a domain the customer already owns at another registrar.

Change forwarding URLs in bulk

Repoint many domains at a new URL in one call.

How to implement domain swaps

Replace a degrading domain inside an active order.

Changing user names on active orders

Rename inboxes on a warm domain — for team rotations.
Last modified on May 14, 2026