Skip to main content
POST
/
api
/
v1
/
system
/
schools
/
{id}
/
toggle-status
curl --request POST \
  --url https://api.example.com/api/v1/system/schools/{id}/toggle-status/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_active": false
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "is_active": true
  }
}

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.

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this client.

Body

application/json
​
is_active
boolean
required

true to enable, false to disable

Response

​
success
boolean
​
message
string
​
data
object