Hard delete a school (drop schema)

DESTRUCTIVE. Permanently drops the PostgreSQL schema and deletes all school data. Requires explicit confirmation via query param ?confirm=true or header X-Confirm-Delete: true.

DELETE /api/v1/system/schools/{id}

Hard delete a school (drop schema)

cURL

curl --request DELETE \
  --url https://api.example.com/api/v1/system/schools/{id}/ \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Schema-Name · string

School (tenant) identifier. Must match your account unless you have platform-wide access.

X-Confirm-Delete · string

Set to 'true' to confirm hard delete (alternative to query param)

Path Parameters

id · string<uuid> · required

A UUID string identifying this client.

Query Parameters

confirm · boolean

Set to true to confirm hard delete (e.g. ?confirm=true)

Response

200

application/json

success · boolean

message · string