Estimate Recipients
Count how many contacts match an audience right now (contact, tag, segment, smart_list, custom_segment or all) and get a one-line summary to confirm with the user before scheduling. The count is before send-time suppression: do-not-disturb, unsubscribed and contacts without a valid email are skipped at send, so tell the user it is the most that can receive the campaign, not a delivery count. Returns the count only, never contact ids. Write-scoped because an exact count for any filter would otherwise let a read-only token enumerate contacts.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
emails/ campaigns. writeOAuthPrivate IntegrationSub-Account TokenRequest
Headers
API Version
v3v3Path Parameters
Location ID
ve9EPM428h8vShlRW1KTBody
Required when type is contact
["8eHQB5vTbGKdK9UWXL3G"]Required when type is tag
["6YMlGPn0LHi5OmJaXdLB"]Required when type is segment
engaged_last_7_daysengaged_last_30_daysengaged_last_60_daysengaged_last_5_campaignsunengaged_last_5_campaignsengaged_last_30_daysRequired when type is smart_list. Only the first is used.
["f2a6b1c4-3d1e-4c8e-9a7b-2f4c6e8d0a1b"]Required when type is custom_segment
Freeze the contact list at schedule time
falseWho receives the campaign: contact (contactIds), tag (tagIds), segment, smart_list (smartListIds; first is used), custom_segment (conditions) or all (every contact in the location).
contacttagsegmentsmart_listcustom_segmentallsmart_listResponse
Success
Audience type that was estimated.
contacttagsegmentsmart_listcustom_segmentallsmart_listContacts matching this audience right now, before send-time suppression. Contacts with email do-not-disturb, unsubscribed, or without a valid email are skipped when the campaign sends, so fewer may receive it.
1240One-line summary to show the user before scheduling.
Smart list