Admin - Schools

Update School

Changed on

Update an existing school. Only accessible by admin users.

put/admin/schools/{school_id}

Request

  • Base URL: https://api.excellence-ai.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.excellence-ai.com/admin/schools/{school_id}
  • Auth: OAuth 2 (password, token URL api/login)

Path parameters

school_idstring required

The ID of the school to update

Request body

namestring nullable
email_domainstring nullable
french_school_idstring nullable
contact_emailstring email nullable
contact_namestring nullable
phone_numberstring nullable
addressstring nullable
citystring nullable
max_teachersinteger nullable
max_studentsinteger nullable
notesstring nullable
expected_teachersstring[] nullable

Response

Successful Response

idstring required
namestring required
email_domainstring nullable
uaistring nullable
french_school_idstring nullable
french_school_namestring nullable
contact_emailstring email nullable
contact_namestring nullable
phone_numberstring nullable
addressstring nullable
citystring nullable
contract_type'free' | 'pilot' | 'paid' | 'expired' required
contract_start_datestring date-time nullable
contract_end_datestring date-time nullable
max_teachersinteger nullable
max_studentsinteger nullable
notesstring nullable
expected_teachersstring[]
created_bystring required
created_atstring date-time required
updated_atstring date-time required
current_contract_idstring nullable
current_contract_status'active' | 'upcoming' | 'ended' nullable
attio_company_idstring nullable
attio_web_urlstring nullable
logo_data_urlstring nullable
teacher_countinteger

Changes

  • 59dba414f8aeRevision changes
    • info

      added the optional property to the response with the status

  • 437cd8414e9eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status