PATCH /api/admin/schools/{orgId}

Developing

PATCH

/api/admin/schools/{orgId}

PATCH /api/admin/schools/:orgId {suspended, cursor?} | {reinvite: true} (schools.manage, step-up); each audited. A
status answer with a cursor means students are still being turned off/on: send it back to carry on.

Staff cookie session; permission schools.manage; fresh password + TOTP step-up (10 minutes). Write requests need same-origin JSON and X-Admin-CSRF from this session.

Source snapshot: admin/src/app/api/admin/schools/[orgId]/route.ts. This reference describes the current working tree, not proof of deployment. The response service types and validators remain authoritative.

Request

Authorization

API Key

Add parameter in cookie

__Host-hwa_session

Example:

__Host-hwa_session: ********************

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Bodyapplication/json

🟠400

🟠401

🟠403

🟠429

⚪default

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/admin/schools/' \
--header 'X-Admin-CSRF;' \
--header 'Content-Type: application/json' \
--data '{
    "suspended": true,
    "cursor": "string"
}'

Response Example

200 - Example 1

{}

Modified at 2026-10-26 13:41:16

GET /api/admin/schools/{orgId}

GET /api/admin/schools