Skip to main content

BroadcastEstimate

recipientsinteger
totalinteger
skipped object

Who is left out, by reason: no_identity, opted_out, suppressed, no_consent (marketing) or invalid_number.

property name*integer
capintegernullable

Recipient cap: the lowest of the platform maximum, 10× the largest completed campaign (1,000 on the first) and the plan limit.

firstCampaignboolean
overCapinteger
remainingQuotaintegernullable
portfolioLimitintegernullable

Business-initiated conversation limit per 24 hours, from the number's tier at Meta. null when unlimited or unknown.

estimatedCost objectnullable

Estimated cost in micros (millionths of the currency). null when no country could be priced.

microsinteger
currencystring
byCountry object[]
  • Array [
  • countrystringnullable
    marketstring
    recipientsinteger
    rateMicrosintegernullable
  • ]
  • unpricedinteger
    BroadcastEstimate
    {
    "recipients": 0,
    "total": 0,
    "skipped": {},
    "cap": 0,
    "firstCampaign": true,
    "overCap": 0,
    "remainingQuota": 0,
    "portfolioLimit": 0,
    "estimatedCost": {
    "micros": 0,
    "currency": "string",
    "byCountry": [
    {
    "country": "string",
    "market": "string",
    "recipients": 0,
    "rateMicros": 0
    }
    ],
    "unpriced": 0
    }
    }