Skip to main content
POST
/
api
/
v1
/
system
/
schools
/
migrate-schema
Run migrations for a tenant schema
curl --request POST \
  --url https://api.example.com/api/v1/system/schools/migrate-schema/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schema_name": "example_academy"
}
'
{}

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.

Body

application/json
​
schema_name
string
required

Tenant schema name to migrate

Response

Schema migrated successfully