inviteUserByEmail()

Sends an invite link to an email address.

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

Parameters#

  • emailrequired
    string

    The email address of the user.

  • optionsrequired
    object

    No description provided.

      Properties
    • dataoptional
      object

      Optional user metadata

    • redirectTooptional
      string

      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#

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