> 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. # Update an entity PATCH https://ssuccessv2.com/app/api/v1/entity/update/{id} Content-Type: application/json Updates an entity and, when supplied, creates or updates its address. Reference: https://docs.schoolset.io/api-reference/school-set-api/entities/update-entity ## Authentication - `Authorization` header (bearer token, required) — The signed-in SchoolSet user token sent by the frontend. ## Request ### Path parameters - `id` (integer, required) — Entity ID. ### Body (application/json) This endpoint expects an object. - `entity_type_id` (integer, required) - `name` (string, required) - `legal_name` (string, optional, nullable) - `tax_id` (string, optional, nullable) - `tax_exempt` (boolean, optional, nullable) - `email` (string, optional, nullable) - `phone` (string, optional, nullable) - `note` (string, optional, nullable) - `address` (list of map from string to any, optional, nullable) - `donation_receipt_not_allowed` (boolean, optional, nullable) - `processing_fee_blocked` (boolean, optional, nullable) ## Response ### 200 Entity updated. - `status` (string, optional) - `message` (string, optional) - `data` (ApiV1EntityUpdateIdPatchResponsesContentApplicationJsonSchemaData, optional) ## Errors ### 401 Unauthorized Error Authentication is required. - `status` (string, required) - `message` (string, required) - `data` (any, optional, nullable) ### 403 Forbidden Error The user lacks permission to edit entities. - `status` (string, required) - `message` (string, required) - `data` (any, optional, nullable) ### 404 Not Found Error The entity does not exist. - `status` (string, required) - `message` (string, required) - `data` (any, optional, nullable) ### 422 Unprocessable Entity Error The entity data failed validation. - `message` (string, required) - `errors` (map from string to list of string, required) ## Types ### ApiV1EntityUpdateIdPatchResponsesContentApplicationJsonSchemaData ## Examples **Request** ```json { "entity_type_id": 4, "name": "Rivera Family Foundation", "tax_exempt": true, "email": "finance@riverafoundation.org" } ``` **Response** ```json { "status": "success", "message": "Entity updated.", "data": { "id": 91, "name": "Rivera Family Foundation", "legal_name": "Rivera Family Foundation Inc.", "tax_id": "11-2345678", "tax_exempt": true, "email": "finance@riverafoundation.org", "phone": "+1-212-555-0160", "note": "Updated sponsor note", "type": null, "addresses": null, "total_paid": null, "total_fees": null, "total_due_today": null, "donation_receipt_not_allowed": false, "processing_fee_blocked": false, "is_processing_fee_blocked": false } } ``` **SDK Code** ```python Entities_updateEntity_example import requests url = "https://ssuccessv2.com/app/api/v1/entity/update/91" payload = { "entity_type_id": 4, "name": "Rivera Family Foundation", "tax_exempt": True, "email": "finance@riverafoundation.org" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Entities_updateEntity_example const url = 'https://ssuccessv2.com/app/api/v1/entity/update/91'; const options = { method: 'PATCH', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"entity_type_id":4,"name":"Rivera Family Foundation","tax_exempt":true,"email":"finance@riverafoundation.org"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Entities_updateEntity_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://ssuccessv2.com/app/api/v1/entity/update/91" payload := strings.NewReader("{\n \"entity_type_id\": 4,\n \"name\": \"Rivera Family Foundation\",\n \"tax_exempt\": true,\n \"email\": \"finance@riverafoundation.org\"\n}") req, _ := http.NewRequest("PATCH", 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 Entities_updateEntity_example require 'uri' require 'net/http' url = URI("https://ssuccessv2.com/app/api/v1/entity/update/91") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"entity_type_id\": 4,\n \"name\": \"Rivera Family Foundation\",\n \"tax_exempt\": true,\n \"email\": \"finance@riverafoundation.org\"\n}" response = http.request(request) puts response.read_body ``` ```java Entities_updateEntity_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://ssuccessv2.com/app/api/v1/entity/update/91") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"entity_type_id\": 4,\n \"name\": \"Rivera Family Foundation\",\n \"tax_exempt\": true,\n \"email\": \"finance@riverafoundation.org\"\n}") .asString(); ``` ```php Entities_updateEntity_example request('PATCH', 'https://ssuccessv2.com/app/api/v1/entity/update/91', [ 'body' => '{ "entity_type_id": 4, "name": "Rivera Family Foundation", "tax_exempt": true, "email": "finance@riverafoundation.org" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Entities_updateEntity_example using RestSharp; var client = new RestClient("https://ssuccessv2.com/app/api/v1/entity/update/91"); var request = new RestRequest(Method.PATCH); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"entity_type_id\": 4,\n \"name\": \"Rivera Family Foundation\",\n \"tax_exempt\": true,\n \"email\": \"finance@riverafoundation.org\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Entities_updateEntity_example import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "entity_type_id": 4, "name": "Rivera Family Foundation", "tax_exempt": true, "email": "finance@riverafoundation.org" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/entity/update/91")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" 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() ```