sendPasswordResetEmail

Request a password reset for a user account. An email with a verification link will be sent to the user’s email address to complete the password reset process.

POST /user/password/reset

Request password reset

cURL

curl --request POST \
  --url https://{subdomain}.auth.{region}.nhost.run/v1/user/password/reset \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[e-mail]",
  "options": {
    "redirectTo": "https://my-app.com/catch-redirection"
  }
}
'

200

"OK"

Body

application/json

Email address and optional redirect URL for password reset

email · string<email> · required

A valid email

Example:

"[e-mail]"

options · object

Show child attributes

options. redirectTo · string<uri>

Example:

"https://my-app.com/catch-redirection"

Response

200

application/json

Password reset requested

The response is of type enum<string>.

Available options: OK