> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.schoolset.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.schoolset.io/_mcp/server. # Create a student POST https://ssuccessv2.com/app/api/v2/student/create Content-Type: application/json Creates a student in the active school, associates the supplied family and academic year, optionally places the student in a class or grade, creates each supplied address, and returns the v2 student resource. Creating students requires create-students permission. Reference: https://docs.schoolset.io/api-reference/school-set-api/students/create-student-v-2 ## Authentication - `Authorization` header (bearer token, required) — The signed-in SchoolSet user token sent by the frontend. ## Request ### Body (application/json) This endpoint expects an object. - `firstname` (string, required) - `lastname` (string, required) - `address` (list of ApiV2StudentCreatePostRequestBodyContentApplicationJsonSchemaAddressItems, required) - `family_id` (integer, required) - `academ_year_id` (integer, required) - `firstname_hebrew` (string, optional, nullable) - `lastname_hebrew` (string, optional, nullable) - `phone` (string, optional, nullable) - `email` (string, optional, nullable) - `dob` (date, optional, nullable) - `dob_hebrew` (string, optional, nullable) - `gender` (enum, optional) - Allowed values: `male`, `female` - `class_id` (integer, optional, nullable) - `grade_id` (integer, optional, nullable) ## Response ### 200 Student created and returned as a v2 student resource. - `status` (string, required) - `message` (string, required) - `data` (map from string to any, required) ## Errors ### 401 Unauthorized Error Authentication is missing or invalid. - `status` (string, required) - `message` (string, required) - `data` (any, optional, nullable) ### 403 Forbidden Error The authenticated user lacks create-students permission. - `status` (string, required) - `message` (string, required) - `data` (any, optional, nullable) ### 422 Unprocessable Entity Error Student or address input failed validation. - `message` (string, required) - `errors` (map from string to list of string, required) ## Types ### ApiV2StudentCreatePostRequestBodyContentApplicationJsonSchemaAddressItems - `splitted` (map from string to any, required) - `components` (map from string to any, optional) - `formatted` (string, optional, nullable) - `longitude` (double, optional, nullable) - `latitude` (double, optional, nullable) - `tag` (string, optional, nullable) ## Examples **Request** ```json { "firstname": "Sarah", "lastname": "Cohen", "address": [ { "splitted": { "city": "New York", "state": "NY", "zip": "10001" }, "components": {}, "formatted": "1 Main St, New York, NY", "longitude": -73.99, "latitude": 40.75, "tag": "home" } ], "family_id": 41, "academ_year_id": 9, "email": "sarah.cohen@example.com", "dob": "2023-01-15", "gender": "female", "grade_id": 3 } ``` **Response** ```json { "status": "success", "message": "Saved successfully.", "data": {} } ``` **SDK Code** ```python import requests url = "https://ssuccessv2.com/app/api/v2/student/create" payload = { "firstname": "Sarah", "lastname": "Cohen", "address": [ { "splitted": { "city": "New York", "state": "NY", "zip": "10001" }, "components": {}, "formatted": "1 Main St, New York, NY", "longitude": -73.99, "latitude": 40.75, "tag": "home" } ], "family_id": 41, "academ_year_id": 9, "email": "sarah.cohen@example.com", "dob": "2023-01-15", "gender": "female", "grade_id": 3 } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://ssuccessv2.com/app/api/v2/student/create'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"firstname":"Sarah","lastname":"Cohen","address":[{"splitted":{"city":"New York","state":"NY","zip":"10001"},"components":{},"formatted":"1 Main St, New York, NY","longitude":-73.99,"latitude":40.75,"tag":"home"}],"family_id":41,"academ_year_id":9,"email":"sarah.cohen@example.com","dob":"2023-01-15","gender":"female","grade_id":3}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://ssuccessv2.com/app/api/v2/student/create" payload := strings.NewReader("{\n \"firstname\": \"Sarah\",\n \"lastname\": \"Cohen\",\n \"address\": [\n {\n \"splitted\": {\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zip\": \"10001\"\n },\n \"components\": {},\n \"formatted\": \"1 Main St, New York, NY\",\n \"longitude\": -73.99,\n \"latitude\": 40.75,\n \"tag\": \"home\"\n }\n ],\n \"family_id\": 41,\n \"academ_year_id\": 9,\n \"email\": \"sarah.cohen@example.com\",\n \"dob\": \"2023-01-15\",\n \"gender\": \"female\",\n \"grade_id\": 3\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://ssuccessv2.com/app/api/v2/student/create") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"firstname\": \"Sarah\",\n \"lastname\": \"Cohen\",\n \"address\": [\n {\n \"splitted\": {\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zip\": \"10001\"\n },\n \"components\": {},\n \"formatted\": \"1 Main St, New York, NY\",\n \"longitude\": -73.99,\n \"latitude\": 40.75,\n \"tag\": \"home\"\n }\n ],\n \"family_id\": 41,\n \"academ_year_id\": 9,\n \"email\": \"sarah.cohen@example.com\",\n \"dob\": \"2023-01-15\",\n \"gender\": \"female\",\n \"grade_id\": 3\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://ssuccessv2.com/app/api/v2/student/create") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"firstname\": \"Sarah\",\n \"lastname\": \"Cohen\",\n \"address\": [\n {\n \"splitted\": {\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zip\": \"10001\"\n },\n \"components\": {},\n \"formatted\": \"1 Main St, New York, NY\",\n \"longitude\": -73.99,\n \"latitude\": 40.75,\n \"tag\": \"home\"\n }\n ],\n \"family_id\": 41,\n \"academ_year_id\": 9,\n \"email\": \"sarah.cohen@example.com\",\n \"dob\": \"2023-01-15\",\n \"gender\": \"female\",\n \"grade_id\": 3\n}") .asString(); ``` ```php request('POST', 'https://ssuccessv2.com/app/api/v2/student/create', [ 'body' => '{ "firstname": "Sarah", "lastname": "Cohen", "address": [ { "splitted": { "city": "New York", "state": "NY", "zip": "10001" }, "components": {}, "formatted": "1 Main St, New York, NY", "longitude": -73.99, "latitude": 40.75, "tag": "home" } ], "family_id": 41, "academ_year_id": 9, "email": "sarah.cohen@example.com", "dob": "2023-01-15", "gender": "female", "grade_id": 3 }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://ssuccessv2.com/app/api/v2/student/create"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"firstname\": \"Sarah\",\n \"lastname\": \"Cohen\",\n \"address\": [\n {\n \"splitted\": {\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zip\": \"10001\"\n },\n \"components\": {},\n \"formatted\": \"1 Main St, New York, NY\",\n \"longitude\": -73.99,\n \"latitude\": 40.75,\n \"tag\": \"home\"\n }\n ],\n \"family_id\": 41,\n \"academ_year_id\": 9,\n \"email\": \"sarah.cohen@example.com\",\n \"dob\": \"2023-01-15\",\n \"gender\": \"female\",\n \"grade_id\": 3\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "firstname": "Sarah", "lastname": "Cohen", "address": [ [ "splitted": [ "city": "New York", "state": "NY", "zip": "10001" ], "components": [], "formatted": "1 Main St, New York, NY", "longitude": -73.99, "latitude": 40.75, "tag": "home" ] ], "family_id": 41, "academ_year_id": 9, "email": "sarah.cohen@example.com", "dob": "2023-01-15", "gender": "female", "grade_id": 3 ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v2/student/create")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```