Skip to main content
POST
/
bundles
curl --request POST \ --url https://api.peeker.ai/partner/v1/bundles \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "Starter — 25k emails/month", "monthly_sending_volume": 25000 } '
{
  "data": {
    "id": "bun_01HZX0BU1A2B3C4D5E6F7G8H",
    "name": "Starter — 25k emails/month",
    "monthly_sending_volume": 25000,
    "google_percent": null,
    "microsoft_percent": null,
    "send_on_weekends": false,
    "google_inboxes_per_domain": 2,
    "status": "active",
    "effective": {
      "google_percent": 50,
      "microsoft_percent": 50
    },
    "required_domains": {
      "google": 15,
      "microsoft": 4,
      "total": 19
    },
    "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
name
string
required

A friendly name (e.g. "Starter — 25k emails/month").

monthly_sending_volume
integer
required

How many emails per month this bundle is sized for.

google_percent
integer | null

Percent of emails handled by Google. If you set this, also set microsoft_percent (they must add to 100). Send null or omit both to inherit Peeker's recommended split.

microsoft_percent
integer | null
send_on_weekends
boolean
default:false

Defaults to false, so monthly volume is spread across 22 weekday sending days. Set true to spread it across 30 days.

google_inboxes_per_domain
enum<integer>
default:2

Google inbox density per domain. 2 gives 40 Google sends/domain/day; 3 gives 60.

Available options:
2,
3

Response

201 - application/json

A bundle.

data
object
required
Last modified on June 16, 2026