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

Params

Param name Description
email
optional , blank allowed

Validations:

  • Must be a String
username
optional , blank allowed

Required if the email is shared accross multiple users

Validations:

  • Must be a String
id
optional , blank allowed

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
optional , blank allowed

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

Validations:

  • Must be a String
app_name
optional , blank allowed

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
invited_to_url
optional , blank allowed

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

Validations:

  • Must be a String
try_to_find_existing_user
optional , blank allowed

Will try to find an existing user by the params supplied, instead of creating a new one

Validations:

  • Must be one of: true, false, true, false.
given_name
optional , blank allowed

Validations:

  • Must be a String
family_name
optional , blank allowed

Validations:

  • Must be a String
non_latin_given_name
optional , blank allowed

Validations:

  • Must be a String
non_latin_family_name
optional , blank allowed

Validations:

  • Must be a String
male
optional , blank allowed

Gender: Wether the user is a male or female

Validations:

  • Must be one of: true, false, true, false.
birthdate
optional , blank allowed

Validations:

  • Must be a String
primary_country
optional , blank allowed

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 , blank allowed

Have the user already completed a 10day course?

Validations:

  • Must be one of: true, false, true, false.
is_at
optional , blank allowed

Is the user an assistant teacher?

Validations:

  • Must be one of: true, false, true, false.
at_code
optional , blank allowed

Assistant teacher code, for example AD5, YNP, NJ

Validations:

  • Must be a String
is_cct
optional , blank allowed

Is the user an children course teacher?

Validations:

  • Must be one of: true, false, true, false.
student_account_app
optional , blank allowed

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 , blank allowed

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 , blank allowed

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
office365_id
optional , blank allowed

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 , blank allowed

Office365 email of this user, something like [email protected]

Validations:

  • Must be a String

Returns

Code: 200

Description:

Invitation result with success code and user object. Response format: {invite_success_code: 'invited'|'existing_user_invited', user: user_object}

Param name Description

Code: 422

Description:

Validation errors in format: {error: error_message}

Param name Description

Code: 400

Description:

Error message for invalid operations (e.g., trying to invite generic oldstudent record), in format: {error: error_message}

Param name Description

Code: 401

Description:

Unauthorized - invalid or missing OAuth token

Param name Description