HomeTutorialsAPI ReferenceStatus
API Reference

Retrieve Segment Recipient Count

post
https://{APP_DOMAIN}/api/3.2/messages/segments/recipient-counts

Returns the deduplicated send-recipient count for included segments after applying excluded segments.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Segment selections

included_segment_ids
array of integers
required
included_segment_ids*
excluded_segment_ids
array of integers
excluded_segment_ids
string
enum
Allowed:
boolean

Also return email recipients grouped by the locale stored on their email address. Recipients without a locale are counted under the default locale.

Response
200

The recipient count, plus by_locale (locale => count) when requested

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…

Updated 3 months ago

Did this page help you?