Send an email invite link

Parameters

• email

  REQUIRED

  string

  The email address of the user.

• options

  Optional

  object

  Additional options to be included when inviting.

  Open accepted values

  data

  Optional

  object

  A custom data object to store additional metadata about the user. This maps to the `auth.users.user_metadata` column.

  redirectTo

  Optional

  string

  The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL.