API documentation

Params

Param name	Description
id required	ID of the user to update Validations: Must be a String
given_name optional	Validations: Must be a String
family_name optional	Validations: Must be a String
non_latin_given_name optional	Validations: Must be a String
non_latin_family_name optional	Validations: Must be a String
male optional	Gender: Wether the user is a male or female Validations: Must be one of: `true`, `false`, `true`, `false`.
birthdate optional	Validations: Must be a String
primary_country optional	Alpha2 code of the country where the user do most of its Vipassana activity just give address country if you are not sure Validations: Must be a String
old_student optional	Have the user already completed a 10day course? Validations: Must be one of: `true`, `false`, `true`, `false`.
is_at optional	Is the user an assistant teacher? Validations: Must be one of: `true`, `false`, `true`, `false`.
at_code optional	Assistant teacher code, for example AD5, YNP, NJ Validations: Must be a String
is_cct optional	Is the user an children course teacher? Validations: Must be one of: `true`, `false`, `true`, `false`.
student_account_app optional	Which student app should be used. If not provided, it will be automatically detected from primary_country Validations: Must be one of: `mycourses`, `do_student_account`.
password_required optional	If the user is required to setup a password (otherwise they might only sign in with external providers such as google or office365) Validations: Must be one of: `true`, `false`, `true`, `false`.
require_mfa_from_date optional	Date after which the user will have to set up MFA for her account. Format must be YYYY-MM-DD Validations: Must be a String
office365_id optional	UID of an Office365 account linked to this user. Can be updated only if the current value is blank. Validations: Must be a String
office365_email optional	Office365 email of this user, something like [email protected] Validations: Must be a String