Skip to main content
POST
Send an end-of-week report email

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
studentId
string
required

OneRoster student sourcedId

Minimum string length: 1
Example:

"student-alpha-001"

year
string
required

Report year

Pattern: ^\d{4}$
Example:

"2026"

period
string
required

End-of-week report week number, 1-53

Example:

"23"

mode
string
required
Allowed value: "live"
retryFailed
boolean

Permit definitive failed outcomes to start a new attempt

Response

Email delivery outcomes

data
object
required