Skip to main content
GET
/
api
/
public
/
v1
/
sender-accounts
/
quotas
Get per-inbox daily quotas for a campaign
curl --request GET \
  --url https://api.coldsend.pro/api/public/v1/sender-accounts/quotas \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "message": "<string>",
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date": "<string>",
  "reset_at_utc": "2023-11-07T05:31:56Z",
  "ramp_up_enabled": false,
  "ramp_up_increment": 0,
  "ramp_up_max_limit": 0,
  "inboxes": [
    {
      "inbox_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email_address": "<string>",
      "inbox_daily_limit": 123,
      "effective_daily_limit": 123,
      "effective_limit_source": "<string>",
      "inbox_usage_today": 123,
      "campaign_usage_today": 123,
      "effective_remaining": 123,
      "is_rate_limited": true,
      "reset_at_utc": "2023-11-07T05:31:56Z",
      "campaign_daily_limit": 123,
      "ramp_up_current_day": 123,
      "ramp_up_daily_limit": 123
    }
  ]
}

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.