--- id: auth-api-inviteuserbyemail title: "inviteUserByEmail()" slug: auth-api-inviteuserbyemail custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml --- import Tabs from '@theme/Tabs'; import TabsPanel from '@theme/TabsPanel'; Sends an invite link to an email address. ## Parameters ## 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. ```js const { data: user, error } = await supabase.auth .api .inviteUserByEmail('email@example.com') ```