Skip to main content
POST
/
orders
curl --request POST \ --url https://api.peeker.ai/partner/v1/orders \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "user": "client@example.com", "bundle_id": "bun_123", "sequencer": { "provider": "smartlead", "client_id": 366903, "login_email": "smartlead-login@example.com", "login_password": "secret-password" }, "domains": [ "domain-01.com", "domain-02.com", "domain-03.com", "domain-04.com", "domain-05.com", "domain-06.com", "domain-07.com", "domain-08.com", "domain-09.com", "domain-10.com" ], "personas": [ { "first_name": "Sam", "last_name": "Lee", "profile_picture_url": "" } ] } '
{ "data": { "id": "ord_01HZX0OR1A2B3C4D5E6F7G8H", "user_id": "usr_01HZX0C6Z3K4M5N6P7Q8R9S0", "email": "client@example.com", "bundle_id": "bun_123", "status": "in_progress", "domain_count": 2, "costs": { "total_cents": 6800, "currency": "usd" }, "renews_at": "2026-06-08T12:00:00Z", "created_at": "2026-05-08T12:00:00Z" } }

Authorizations

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

Your partner API key. Use pk_live_… against the live system or pk_test_… against the sandbox.

Body

application/json
​
user
string
required

Existing usr_… customer ID, or an email to reuse/create.

Example:

"client@example.com"

​
bundle_id
string
required

Saved bundle to use for license counts and inbox density.

Example:

"bun_123"

​
sequencer
object
required
​
domains
(string | object)[]
required

One entry per domain. Use a plain string for the common case (the domain inherits the order-level forwarding_url). Pass an object only when a single domain needs its own forwarding URL.

Domain name. Inherits forwarding_url from the order.

Example:

"acme-mail.com"

Example:
[
  "domain-01.com",
  "domain-02.com",
  "domain-03.com",
  "domain-04.com",
  "domain-05.com",
  "domain-06.com",
  "domain-07.com",
  "domain-08.com",
  "domain-09.com",
  "domain-10.com"
]
​
personas
object[]
required

Up to 10 personas to use when generating inbox names. Peeker auto-generates the inbox usernames/local parts from these names.

Maximum array length: 10
​
forwarding_url
string

A default redirect for every domain in this order.

Response

Lean order receipt returned by create and list endpoints.

​
data
object
required
Last modified on June 16, 2026