Skip to content

/auth/forget-password

POST
/auth/forget-password

Send a password reset email to the user

Authorizations

Request Body required

object
email
required

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

string
redirectTo

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

string

Responses

200

Success

object
status
boolean

400

Bad Request. Usually due to missing parameters, or invalid parameters.

object
message
required
string

401

Unauthorized. Due to missing or invalid authentication.

object
message
required
string

403

Forbidden. You do not have permission to access this resource or to perform this action.

object
message
string

404

Not Found. The requested resource was not found.

object
message
string

429

Too Many Requests. You have exceeded the rate limit. Try again later.

object
message
string

500

Internal Server Error. This is a problem with the server that you cannot fix.

object
message
string