Settings

Update Parameters

Changed on

Update the current user's parameters.

patch/settings/profile

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/settings/profile
  • Auth: OAuth 2 (password, token URL api/login)

Request body

first_namestring nullable
last_namestring nullable
civility'mme' | 'm' | 'none' nullable

Teacher civility shown to students (« Mme Dubois »); 'none' clears it, leaving « Professeur Dubois » — only for teachers

gradestring nullable

Student level / classe (e.g. 3eme, 2nde, Terminale, CPGE_Sup)

filierestring nullable

CPGE track (Sup, MP, PC, PSI, ECG, sup_ecg_math_appliques, sup_ecg_math_approfondi) — only for students; keeps grade and année in sync

prepa_yearinteger nullable

Prépa year (1 or 2)

prepa_trackstring nullable

Prépa track of that year (MPSI, PCSI, MP, ECG…) or 'other'

prepa_maths_optionstring nullable

ECG maths option: appliquees or approfondies

teacher_type'lycée' | 'prepa' nullable

Teacher type (only for teachers)

subject'maths' | 'physique-chimie' nullable

Matière taught (only for teachers)

beta_features_enabledboolean nullable

Enable early-access and beta product features

cpge_library_enabledboolean nullable

Opt-in for lycée maths teachers to see CPGE exercises in the exercise library (only for teachers)

Response

Successful Response

emailstring required
full_namestring nullable
first_namestring nullable
last_namestring nullable
civility'mme' | 'm' nullable
rolestring nullable
gradestring nullable
filierestring nullable
prepa_yearinteger nullable
prepa_trackstring nullable
prepa_maths_optionstring nullable
teacher_type'lycée' | 'prepa' nullable
subject'maths' | 'physique-chimie' nullable
has_limited_accessboolean nullable
beta_features_enabledboolean
cpge_library_enabledboolean nullable

Changes

  • 12e0c1618a4aRevision changes
    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 518c1e6178a3Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status