Skip to main content
Version: v2 RC

inviteUserByEmail()

Sends an invite link to an email address.

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

Parameters

  • emailrequiredstring

    The email address of the user.

  • optionsrequiredobject

    No description provided.

      Properties
    • dataoptionalobject

      Optional user metadata

    • redirectTooptionalstring

      A URL or mobile deeplink to send the user to after they are confirmed.

Notes

  • Sends an invite link to the user's email address.

Examples

Invite a user

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