Admin - School Codes

Update School Code

Update a school code. Only accessible by admins.

put/admin/school-codes/{code_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/school-codes/{code_id}
  • Auth: OAuth 2 (password, token URL api/login)

Path parameters

code_idstring required

Request body

school_namestring nullable
descriptionstring nullable
is_activeboolean nullable
max_usesinteger nullable

Response

Successful Response

idstring required
codestring required
school_namestring required
descriptionstring nullable
is_activeboolean required
max_usesinteger nullable
current_usesinteger required
created_bystring required
created_atstring date-time required
updated_atstring date-time required

Changes

No operation changes recorded.