Send an email invite link
Sends an invite link to an email address.
- Sends an invite link to the user's email address.
Parameters
- emailREQUIREDstring
The email address of the user.
- optionsOptionalobject
Additional options to be included when inviting.
dataOptionalobjectA custom data object to store additional metadata about the user. This maps to the `auth.users.user_metadata` column.
redirectToOptionalstringThe 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.
const { data, error } = await supabase.auth.admin.inviteUserByEmail('email@example.com')