Who a group would reach, without sending
POST /v1/notifications/audience
POST
/v1/notifications/audience
Takes the group fields of POST /v1/notifications (user_ids, emails, contact_ids, contacts) and answers how many people that is, how many can be reached (a known user id), and up to 20 who cannot. Sends nothing and counts nothing.
Auth: Secret key only. The dashboard has the same operation under /v1/dashboard/notifications.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ”object
user_ids
Array<string>
emails
Array<string>
contact_ids
Array<string>
contacts
object
key
additional properties
string
Responses
Section titled “ Responses ”The group
object
data
object
people
integer
reachable
integer
too_many
boolean
max_recipients
integer
unreachable
integer
unreachable_sample
Array<string>
error
null
meta
object
Error envelope. See error.code for the discriminator.
object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties
Error envelope. See error.code for the discriminator.
object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties
Error envelope. See error.code for the discriminator.
object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties