Skip to main content
POST
Offboard Student

Authorizations

Authorization
string
header
required

Org API key as Token token=ei_live_...

Path Parameters

student_id
string
required

Response

Successful Response

Result of POST /v1/students/{id}/offboard — moves a student to the soft, read-only 'alumni' tier. The student keeps their account and their own past work, loses org-provided premium/AI access, and can request to resume. Counts reflect what the bundling RPC changed; reason is set only on failure.

success
boolean
default:true
scope
string | null
archived_relationships
integer | null
classrooms_removed
integer | null
coverage_revoked
integer | null
reason
string | null