Send enrollment invitation via email
Generate a guest access token and send it via email to allow a parent/guardian to complete the student enrollment form without requiring them to log in.
Supports both user authentication and API token authentication (admin). For API token auth, first obtain a token via /ims/oneroster/v1p1/token endpoint.
Authorizations
Bearer access token from POST /oauth/token (OAuth 2.0 client credentials; the OneRoster /ims/oneroster/v1p1/token and /v1p2/token URLs are aliases). Send it as Authorization: Bearer <access_token>. Tokens expire after 1 hour and carry your API client's granted scopes — an endpoint outside them returns 403.
Body
The email address to send the enrollment invitation to
The school ID to associate with this enrollment invitation
The scopes to grant to the guest token
Number of students to create invitations for
The learning center/campus ID to associate with this enrollment invitation (optional)
The school year ID to associate with this enrollment invitation (optional)
User ID to attribute the invitation to (required when using API token auth)