Skip to main content

inviteUserByEmail()

Sends an invite link to an email address.

Parameters​

  • emailrequiredstring

    The email address of the user.

  • optionsrequiredobject

    No description provided.

      Properties

    • dataoptionalobject

      No description provided.

    • redirectTooptionalstring

      No description provided.

Notes​

  • Requires a service_role key.
  • This function should only be called on a server. Never expose your service_role key in the browser.

Examples​

Basic example.​

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