POST /api/v1/users/invite
Invite by email a user to create an account, or to join an other app if they already have an account

Validations:

• Must be a String

Required if the email is shared accross multiple users

Validations:

• Must be a String

VIS ID of an existing user, in case you just want to invite an existing user to a new app

Validations:

• Must be a String

Locale for invitation and MFA emails (en, fr, de, hi…)

Validations:

• Must be a String

Customize APP_NAME in following email. Default to OauthApplication name Hello, you have been invited to APP_NAME, click link below to accept

Validations:

• Must be a String

Customize the url to redirect the user afer invitation is accepted. Default to OauthApplication home_page

Validations:

• Must be a String

When true, the system attempts to match an existing active user before creating a new one.

Matching is only attempted if the request includes one of the following parameter sets:

• id

• email and username

• email, given_name, family_name, birthdate, and male

If matching is attempted, all provided fields from the following list are used to search for a user: id, username, email, given_name, family_name, birthdate, male.

If exactly one active user matches, that user is invited; otherwise a new user is created.

Validations:

• Must be one of: true, false, true, false.

Validations:

• Must be a String

Validations:

• Must be a String

Validations:

• Must be a String

Validations:

• Must be a String

Gender: Wether the user is a male or female

Validations:

• Must be one of: true, false, true, false.

Validations:

• Must be a String

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

Has the user already completed a 10-day course?

Validations:

• Must be one of: true, false, true, false.

Assistant teacher code, for example AD5, YNP, NJ

Validations:

• Must be a String

Is the user an children course teacher?

Validations:

• Must be one of: true, false, true, false.

Type of teacher the user is. Blank if the user is not a teacher. {“unknown” => “teacher or assistant teacher but VIS does not know its exact type.”, “ATT” => “Assistant Teacher Trainee”, “AT” => “Assistant Teacher”, “SAT” => “Senior Assistant Teacher”, “T” => “Teacher”, “CT” => “Center Teacher”, “CAT” => “Coordinating Area Teacher”, “BT” => “Bhikkhu / Bhikkhuni Teacher”}.

Validations:

• Must be one of: unknown, ATT, AT, SAT, T, CT, CAT, BT.

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.

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.

Date after which the user will have to set up MFA for her account. Format must be YYYY-MM-DD. Users are automatically emailed when a date is set and reminded one week before the date.

Validations:

• Must be a String

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 of this user, something like [email protected]

Validations:

• Must be a String

Google email of this user

Validations:

• Must be a String

Apple email of this user

Validations:

• Must be a String