Javascript Reference v2.0

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.

REQUIRED

string

The email address of the user.

options

Optional

object

Additional options to be included when inviting.

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.


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

Response