Sign in
Default

Send a password reset email to the user

post/auth/request-password-reset

Request

  • Base URL: http://localhost:3001/v1
  • URL: http://localhost:3001/v1/auth/request-password-reset
  • Auth: HTTP bearer

Request body

emailstring required

The email address of the user to send a password reset email to

redirectTostring

The URL to redirect the user to reset their password. If the token isn't valid or expired, it'll be redirected with a query parameter ?error=INVALID_TOKEN. If the token is valid, it'll be redirected with a query parameter `?token=VALID_TOKEN

Response

Success

statusboolean
messagestring

Changes

No operation changes recorded.