Chat

Preview a chat broadcast's reach

Counts whom a broadcast to this audience would reach right now, without sending anything: the distinct creators it would message (creators, campaigns, all), or for groups the groups it would post in (groupCount) and the creators who can read them. Only creators who can receive messages count — they joined your organization or hold a pending invitation. Ids that are archived or not your organization's are ignored here.

get/chat/broadcasts/preview

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/chat/broadcasts/preview
  • Auth: API key in header x-api-key

Query parameters

audience'creators' | 'campaigns' | 'all' | 'groups' required
orgCreatorIdsstring[]
campaignIdsstring[]
groupChatIdsstring[]

Response

OK

recipientCountinteger required
groupCountinteger

Changes

No recorded changes to this operation across all 1 revision of this API.