mirror of
https://github.com/supabase/supabase.git
synced 2026-10-13 13:19:09 +03:00
84 lines
1.1 KiB
Plaintext
84 lines
1.1 KiB
Plaintext
---
|
|
id: api-inviteuserbyemail
|
|
title: "api.inviteUserByEmail"
|
|
slug: api-inviteuserbyemail
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
Sends an invite link to an email address.
|
|
|
|
|
|
|
|
## Parameters
|
|
|
|
|
|
<ul className="method-list-group">
|
|
|
|
<li className="method-list-item">
|
|
<h4 className="method-list-item-label">
|
|
<span className="method-list-item-label-name">
|
|
email
|
|
</span>
|
|
<span className="method-list-item-label-badge required">
|
|
required
|
|
</span>
|
|
<span className="method-list-item-validation">
|
|
string
|
|
</span>
|
|
</h4>
|
|
<div class="method-list-item-description">
|
|
|
|
The email address of the user.
|
|
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
### Send a user an invite link to sign up via email
|
|
|
|
|
|
|
|
<Tabs
|
|
defaultValue="js"
|
|
groupId="libraries"
|
|
values={[{ label: 'JavaScript', value: 'js' },{ label: 'Python', value: 'py' }]}>
|
|
|
|
<TabItem value="js">
|
|
|
|
```js
|
|
const { error, data } = await api
|
|
.inviteUserByEmail('example@email.com')
|
|
```
|
|
|
|
|
|
</TabItem>
|
|
<TabItem value="py">
|
|
|
|
|
|
```
|
|
Not yet implemented
|
|
```
|
|
|
|
|
|
</TabItem>
|
|
|
|
</Tabs> |