JavaScript: Send an email invite link

Sends an invite link to an email address.

• Sends an invite link to the user's email address.
• The inviteUserByEmail() method is typically used by administrators to invite users to join the application.
• Note that PKCE is not supported when using inviteUserByEmail. This is because the browser initiating the invite is often different from the browser accepting the invite which makes it difficult to provide the security guarantees required of the PKCE flow.

Parameters

• email

  (Required)

  The email address of the user.

• options

  (Required)

  Additional options to be included when inviting.

Examples

Invite a user

const { data, error } = await supabase.auth.admin.inviteUserByEmail('email@example.com')