Skip to main content
GET
Get per-inbox daily quotas for a campaign

Authorizations

X-API-Key
string
header
required

API key with format cs_live_xxx

Query Parameters

campaign_id
string<uuid>
required

Campaign ID to retrieve inbox quotas for

Response

Quota data retrieved

Response listing per-inbox daily quota state for a campaign.

success
boolean
required
message
string
required
campaign_id
string<uuid>
required

Campaign ID the quotas apply to

date
string
required

UTC date these counters apply to (YYYY-MM-DD).

reset_at_utc
string<date-time>
required

Next UTC midnight when all counters reset.

ramp_up_enabled
boolean
default:false

Whether ramp-up is enabled for this campaign.

ramp_up_increment
integer
default:0

Emails/inbox/day added per ramp-up day. 0 when ramp-up is disabled.

ramp_up_max_limit
integer
default:0

Fully-ramped daily cap. 0 when ramp-up is disabled.

inboxes
InboxQuotaItem · object[]

Per-inbox quota details, ordered by email_address.