Skip to main content
PATCH
/
bundles
/
{id}
curl --request PATCH \ --url https://api.peeker.ai/partner/v1/bundles/{id} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "Starter — 40k emails/month", "monthly_sending_volume": 40000, "send_on_weekends": false } '
{
  "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.

Path Parameters

​
id
string
required

The bundle ID, e.g. bun_01HZX.

Body

application/json
​
name
string
​
monthly_sending_volume
integer
​
google_percent
integer | null

Set with microsoft_percent, or send both as null to return to Peeker's recommended split.

​
microsoft_percent
integer | null
​
send_on_weekends
boolean

Set false for weekday-only sending or true for weekend sending.

​
google_inboxes_per_domain
enum<integer>
Available options:
2,
3

Response

200 - application/json

A bundle.

​
data
object
required
Last modified on June 29, 2026