organizations
organizations
Preview Announcement Audience
How many students this reaches, and on which channels, BEFORE sending.
POST rather than GET because the audience is a list of group ids and a teacher can pick a dozen sections. Body: {group_ids?: [..]}.
Gated by the SAME rule as the send. A preview that happily counts an audience the send will refuse is how the composer came to advertise "Goes to 25 people" to a teacher of twelve.
post/organizations/{org_id}/announcements/preview
Path parameters
org_idstring required
Headers
authorizationstring nullable
Request body
object required
Response
Successful Response
{"stackTrail":"paths:/organizations/{org_id}/announcements/preview:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}
Changes
No recorded changes to this endpoint across all 2 revisions of this API.