Skip to main content
POST
/
api
/
v1
/
system
/
schools
Provision a new school
curl --request POST \
  --url https://api.example.com/api/v1/system/schools/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "school_name": "<string>",
  "schema_name": "<string>",
  "domain": "<string>",
  "admin_email": "jsmith@example.com",
  "admin_first_name": "<string>",
  "admin_last_name": "<string>",
  "admin_password": "<string>",
  "admin_phone": "<string>"
}
'
{
  "success": true,
  "message": "<string>",
  "school_code": "<string>",
  "admin_email": "<string>",
  "schema": "<string>",
  "domain": "<string>",
  "data": {}
}

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

Serializer for provisioning a new school with admin user.

​
school_name
string
required
Required string length: 1 - 100
​
schema_name
string
required
Required string length: 1 - 63
​
domain
string
required
Required string length: 1 - 100
​
admin_email
string<email>
required
Minimum string length: 1
​
admin_first_name
string
required
Required string length: 1 - 150
​
admin_last_name
string
required
Required string length: 1 - 150
​
admin_password
string
required
Minimum string length: 1
​
admin_phone
string
Maximum string length: 20

Response

​
success
boolean
​
message
string
​
school_code
string
​
admin_email
string
​
schema
string
​
domain
string
​
data
object

Client/school object