> ## Documentation Index > Fetch the complete documentation index at: https://docs.classquill.com/llms.txt > Use this file to discover all available pages before exploring further. # Offboard Student > Offboard a student org-wide → the soft, read-only **alumni** tier. Archives the student's tutoring relationships in your org, removes their org classroom seats, and revokes org-provided premium/AI coverage (freeing any org-paid seat). The account is kept: the student can still see their own past work and can request to resume — re-add or re-invite them to restore access. A student who pays for themselves (or is covered outside your org) keeps that access. Reversible and idempotent — calling it again is a no-op success. 404 if `{student_id}` isn't a student affiliated with your org. Returns `success: false` with a `reason` (`cannot_offboard_owner`, `not_a_member`) when the operation does not apply. Requires the `students:write` scope, which the coarse `write` umbrella does NOT grant — it must be enabled deliberately. ## OpenAPI ````yaml /openapi.json post /v1/students/{student_id}/offboard openapi: 3.1.0 info: title: ClassQuill Public API description: >- REST API for ClassQuill tutoring organisations. Pipe your sessions, invoices, payments, tutor earnings, students, and more into your own tools. Most endpoints are reads; a focused set of writes (each gated by a *:write scope) create or update data, including creating student/tutor/parent accounts. Authenticate every request with an org API key: Authorization: Token token=ei_live_... Mint keys in the ClassQuill app under Settings → Developers. version: 1.0.0 servers: [] security: - ApiKeyAuth: [] tags: - name: General - name: Sessions - name: Tutors - name: Students & Parents - name: Billing - name: Curriculum - name: Coursework - name: Operations - name: Pricing - name: Bookings - name: Blog - name: Reports paths: /v1/students/{student_id}/offboard: post: tags: - Students & Parents summary: Offboard Student description: >- Offboard a student org-wide → the soft, read-only **alumni** tier. Archives the student's tutoring relationships in your org, removes their org classroom seats, and revokes org-provided premium/AI coverage (freeing any org-paid seat). The account is kept: the student can still see their own past work and can request to resume — re-add or re-invite them to restore access. A student who pays for themselves (or is covered outside your org) keeps that access. Reversible and idempotent — calling it again is a no-op success. 404 if `{student_id}` isn't a student affiliated with your org. Returns `success: false` with a `reason` (`cannot_offboard_owner`, `not_a_member`) when the operation does not apply. Requires the `students:write` scope, which the coarse `write` umbrella does NOT grant — it must be enabled deliberately. operationId: offboard_student_v1_students__student_id__offboard_post parameters: - name: student_id in: path required: true schema: type: string title: Student Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OffboardResult' '401': description: Missing, malformed, revoked, or expired credentials. content: application/json: schema: $ref: '#/components/schemas/ApiError' '403': description: The credential lacks the scope this endpoint requires. content: application/json: schema: $ref: '#/components/schemas/ApiError' '404': description: >- Not found — the record doesn't exist or belongs to another organisation. content: application/json: schema: $ref: '#/components/schemas/ApiError' '422': description: Validation error — `error.details.errors` lists the fields. content: application/json: schema: $ref: '#/components/schemas/ApiError' '429': description: >- Rate limit exceeded — honour Retry-After and the RateLimit-* headers. content: application/json: schema: $ref: '#/components/schemas/ApiError' components: schemas: OffboardResult: properties: success: type: boolean title: Success default: true scope: anyOf: - type: string - type: 'null' title: Scope archived_relationships: anyOf: - type: integer - type: 'null' title: Archived Relationships classrooms_removed: anyOf: - type: integer - type: 'null' title: Classrooms Removed coverage_revoked: anyOf: - type: integer - type: 'null' title: Coverage Revoked reason: anyOf: - type: string - type: 'null' title: Reason type: object title: OffboardResult description: >- 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. ApiError: description: Canonical error envelope for every /v1 error response (4xx/5xx). properties: error: $ref: '#/components/schemas/ApiErrorBody' required: - error title: ApiError type: object ApiErrorBody: description: The `error` object every /v1 error response carries. properties: code: description: >- Stable machine-readable error code: bad_request, unauthorized, forbidden, not_found, conflict, validation_error, rate_limited, or internal_error. examples: - not_found title: Code type: string message: description: Human-readable explanation, safe to surface to end users. examples: - Session not found title: Message type: string status: description: The HTTP status code, repeated in the body. examples: - 404 title: Status type: integer details: additionalProperties: true description: >- Error-specific context. 422 carries the field errors under `errors`; 429 carries `retry_after_seconds`. title: Details type: object required: - code - message - status title: ApiErrorBody type: object securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: Org API key as `Token token=ei_live_...` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.