> ## 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: EquateIt Public API
  description: >-
    REST API for EquateIt 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 EquateIt 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'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
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.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Org API key as `Token token=ei_live_...`

````