Peeker Partner API

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_licenses": 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"
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

Authorizations

Authorization

string

header

default:Bearer pk_test_<your-test-key>

required

Partner API key (pk_live_… or pk_test_…).

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 use Peeker’s recommended split.

microsoft_percent

integer | null

send_on_weekends

boolean

false = weekdays only. true = include weekends.

google_licenses

enum<integer>

Available options:

1,

2,

3

Response

A bundle.

data

object

required

Show child attributes

Last modified on August 25, 2026

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_licenses": 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"
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}