curl --request POST \
--url https://api.example.com/v1/students \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"full_name": "<string>",
"email": "<string>",
"send_invite": true,
"phone_number": "<string>",
"phone_country_code": "<string>",
"math_level_ids": [
"<string>"
],
"addresses": [
{
"label": "<string>",
"street_address": "<string>",
"suburb": "<string>",
"state": "<string>",
"postcode": "<string>",
"is_default": true
}
],
"placement": {
"type": "add_to_org",
"tutor_id": "<string>",
"classroom_id": "<string>",
"group_id": "<string>",
"active_math_level_id": "<string>"
},
"parent": {
"full_name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"phone_country_code": "<string>"
}
}
'import requests
url = "https://api.example.com/v1/students"
payload = {
"full_name": "<string>",
"email": "<string>",
"send_invite": True,
"phone_number": "<string>",
"phone_country_code": "<string>",
"math_level_ids": ["<string>"],
"addresses": [
{
"label": "<string>",
"street_address": "<string>",
"suburb": "<string>",
"state": "<string>",
"postcode": "<string>",
"is_default": True
}
],
"placement": {
"type": "add_to_org",
"tutor_id": "<string>",
"classroom_id": "<string>",
"group_id": "<string>",
"active_math_level_id": "<string>"
},
"parent": {
"full_name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"phone_country_code": "<string>"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
full_name: '<string>',
email: '<string>',
send_invite: true,
phone_number: '<string>',
phone_country_code: '<string>',
math_level_ids: ['<string>'],
addresses: [
{
label: '<string>',
street_address: '<string>',
suburb: '<string>',
state: '<string>',
postcode: '<string>',
is_default: true
}
],
placement: {
type: 'add_to_org',
tutor_id: '<string>',
classroom_id: '<string>',
group_id: '<string>',
active_math_level_id: '<string>'
},
parent: {
full_name: '<string>',
email: '<string>',
phone_number: '<string>',
phone_country_code: '<string>'
}
})
};
fetch('https://api.example.com/v1/students', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/students",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'full_name' => '<string>',
'email' => '<string>',
'send_invite' => true,
'phone_number' => '<string>',
'phone_country_code' => '<string>',
'math_level_ids' => [
'<string>'
],
'addresses' => [
[
'label' => '<string>',
'street_address' => '<string>',
'suburb' => '<string>',
'state' => '<string>',
'postcode' => '<string>',
'is_default' => true
]
],
'placement' => [
'type' => 'add_to_org',
'tutor_id' => '<string>',
'classroom_id' => '<string>',
'group_id' => '<string>',
'active_math_level_id' => '<string>'
],
'parent' => [
'full_name' => '<string>',
'email' => '<string>',
'phone_number' => '<string>',
'phone_country_code' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/students"
payload := strings.NewReader("{\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"send_invite\": true,\n \"phone_number\": \"<string>\",\n \"phone_country_code\": \"<string>\",\n \"math_level_ids\": [\n \"<string>\"\n ],\n \"addresses\": [\n {\n \"label\": \"<string>\",\n \"street_address\": \"<string>\",\n \"suburb\": \"<string>\",\n \"state\": \"<string>\",\n \"postcode\": \"<string>\",\n \"is_default\": true\n }\n ],\n \"placement\": {\n \"type\": \"add_to_org\",\n \"tutor_id\": \"<string>\",\n \"classroom_id\": \"<string>\",\n \"group_id\": \"<string>\",\n \"active_math_level_id\": \"<string>\"\n },\n \"parent\": {\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phone_country_code\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/students")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"send_invite\": true,\n \"phone_number\": \"<string>\",\n \"phone_country_code\": \"<string>\",\n \"math_level_ids\": [\n \"<string>\"\n ],\n \"addresses\": [\n {\n \"label\": \"<string>\",\n \"street_address\": \"<string>\",\n \"suburb\": \"<string>\",\n \"state\": \"<string>\",\n \"postcode\": \"<string>\",\n \"is_default\": true\n }\n ],\n \"placement\": {\n \"type\": \"add_to_org\",\n \"tutor_id\": \"<string>\",\n \"classroom_id\": \"<string>\",\n \"group_id\": \"<string>\",\n \"active_math_level_id\": \"<string>\"\n },\n \"parent\": {\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phone_country_code\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/students")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"send_invite\": true,\n \"phone_number\": \"<string>\",\n \"phone_country_code\": \"<string>\",\n \"math_level_ids\": [\n \"<string>\"\n ],\n \"addresses\": [\n {\n \"label\": \"<string>\",\n \"street_address\": \"<string>\",\n \"suburb\": \"<string>\",\n \"state\": \"<string>\",\n \"postcode\": \"<string>\",\n \"is_default\": true\n }\n ],\n \"placement\": {\n \"type\": \"add_to_org\",\n \"tutor_id\": \"<string>\",\n \"classroom_id\": \"<string>\",\n \"group_id\": \"<string>\",\n \"active_math_level_id\": \"<string>\"\n },\n \"parent\": {\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phone_country_code\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"status": "<string>",
"user_id": "<string>",
"email": "<string>",
"action": "<string>",
"reason": "<string>",
"invited": true,
"placeholder": true
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Create Student
Create a student account (name, subjects, phone, address, placement) and optionally a linked
parent. email is optional (omit → no-email placeholder account, invite later); when a real
email is present and send_invite (default true) is set, emails a set-password link. Cross-org
placement targets return 404.
curl --request POST \
--url https://api.example.com/v1/students \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"full_name": "<string>",
"email": "<string>",
"send_invite": true,
"phone_number": "<string>",
"phone_country_code": "<string>",
"math_level_ids": [
"<string>"
],
"addresses": [
{
"label": "<string>",
"street_address": "<string>",
"suburb": "<string>",
"state": "<string>",
"postcode": "<string>",
"is_default": true
}
],
"placement": {
"type": "add_to_org",
"tutor_id": "<string>",
"classroom_id": "<string>",
"group_id": "<string>",
"active_math_level_id": "<string>"
},
"parent": {
"full_name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"phone_country_code": "<string>"
}
}
'import requests
url = "https://api.example.com/v1/students"
payload = {
"full_name": "<string>",
"email": "<string>",
"send_invite": True,
"phone_number": "<string>",
"phone_country_code": "<string>",
"math_level_ids": ["<string>"],
"addresses": [
{
"label": "<string>",
"street_address": "<string>",
"suburb": "<string>",
"state": "<string>",
"postcode": "<string>",
"is_default": True
}
],
"placement": {
"type": "add_to_org",
"tutor_id": "<string>",
"classroom_id": "<string>",
"group_id": "<string>",
"active_math_level_id": "<string>"
},
"parent": {
"full_name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"phone_country_code": "<string>"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
full_name: '<string>',
email: '<string>',
send_invite: true,
phone_number: '<string>',
phone_country_code: '<string>',
math_level_ids: ['<string>'],
addresses: [
{
label: '<string>',
street_address: '<string>',
suburb: '<string>',
state: '<string>',
postcode: '<string>',
is_default: true
}
],
placement: {
type: 'add_to_org',
tutor_id: '<string>',
classroom_id: '<string>',
group_id: '<string>',
active_math_level_id: '<string>'
},
parent: {
full_name: '<string>',
email: '<string>',
phone_number: '<string>',
phone_country_code: '<string>'
}
})
};
fetch('https://api.example.com/v1/students', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/students",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'full_name' => '<string>',
'email' => '<string>',
'send_invite' => true,
'phone_number' => '<string>',
'phone_country_code' => '<string>',
'math_level_ids' => [
'<string>'
],
'addresses' => [
[
'label' => '<string>',
'street_address' => '<string>',
'suburb' => '<string>',
'state' => '<string>',
'postcode' => '<string>',
'is_default' => true
]
],
'placement' => [
'type' => 'add_to_org',
'tutor_id' => '<string>',
'classroom_id' => '<string>',
'group_id' => '<string>',
'active_math_level_id' => '<string>'
],
'parent' => [
'full_name' => '<string>',
'email' => '<string>',
'phone_number' => '<string>',
'phone_country_code' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/students"
payload := strings.NewReader("{\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"send_invite\": true,\n \"phone_number\": \"<string>\",\n \"phone_country_code\": \"<string>\",\n \"math_level_ids\": [\n \"<string>\"\n ],\n \"addresses\": [\n {\n \"label\": \"<string>\",\n \"street_address\": \"<string>\",\n \"suburb\": \"<string>\",\n \"state\": \"<string>\",\n \"postcode\": \"<string>\",\n \"is_default\": true\n }\n ],\n \"placement\": {\n \"type\": \"add_to_org\",\n \"tutor_id\": \"<string>\",\n \"classroom_id\": \"<string>\",\n \"group_id\": \"<string>\",\n \"active_math_level_id\": \"<string>\"\n },\n \"parent\": {\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phone_country_code\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/students")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"send_invite\": true,\n \"phone_number\": \"<string>\",\n \"phone_country_code\": \"<string>\",\n \"math_level_ids\": [\n \"<string>\"\n ],\n \"addresses\": [\n {\n \"label\": \"<string>\",\n \"street_address\": \"<string>\",\n \"suburb\": \"<string>\",\n \"state\": \"<string>\",\n \"postcode\": \"<string>\",\n \"is_default\": true\n }\n ],\n \"placement\": {\n \"type\": \"add_to_org\",\n \"tutor_id\": \"<string>\",\n \"classroom_id\": \"<string>\",\n \"group_id\": \"<string>\",\n \"active_math_level_id\": \"<string>\"\n },\n \"parent\": {\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phone_country_code\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/students")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"send_invite\": true,\n \"phone_number\": \"<string>\",\n \"phone_country_code\": \"<string>\",\n \"math_level_ids\": [\n \"<string>\"\n ],\n \"addresses\": [\n {\n \"label\": \"<string>\",\n \"street_address\": \"<string>\",\n \"suburb\": \"<string>\",\n \"state\": \"<string>\",\n \"postcode\": \"<string>\",\n \"is_default\": true\n }\n ],\n \"placement\": {\n \"type\": \"add_to_org\",\n \"tutor_id\": \"<string>\",\n \"classroom_id\": \"<string>\",\n \"group_id\": \"<string>\",\n \"active_math_level_id\": \"<string>\"\n },\n \"parent\": {\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"phone_country_code\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"status": "<string>",
"user_id": "<string>",
"email": "<string>",
"action": "<string>",
"reason": "<string>",
"invited": true,
"placeholder": true
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Org API key as Token token=ei_live_...
Headers
Body
POST /v1/students → mint a student account with a known name + fields, place them, and
optionally create + link a parent. Requires scope accounts:write.
email is OPTIONAL: omit it to create the account now (against an internal placeholder
address) and add a real email + invite later. send_invite (default true) controls whether
a set-password email is sent when a real email is present — a no-email account is never
emailed regardless.
Show child attributes
Show child attributes
Where to place a created student. Targets are org-scoped (cross-org → 404).
Show child attributes
Show child attributes
A parent to create + link to the student being created (nested in StudentCreate).
email is optional — omit it to mint a no-email (placeholder) parent account.
Show child attributes
Show child attributes
Response
Successful Response
Result of POST /v1/students|tutors|parents — one entry per account processed (a student with a nested parent returns two).
Show child attributes
Show child attributes
Was this page helpful?