---
url: "https://vueda.dev/v3/reference/api/js/stores/storeUser/methods/forgotPassword.md"
title: "forgotPassword"
---

# forgotPassword

## Overview

Asks the server to email a password reset link.

## Signature

`forgotPassword(payload)`

### Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| <span id="param-payload">payload</span> | `object` | yes | The request body. |

#### payload Properties

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| <span id="param-payload-email">email</span> | `string` |  |  | The email address of the account to reset. |

### Returns

`Promise`

The decoded response data.

## Source

`client/lib/stores/storeUser.js:421`