Skip to content

Password Reset

When the user clicks the reset link in the email, they arrive at your frontend with token and email in the query string. The frontend should submit these values to this endpoint along with a new password.

HTTP Request

POST /api/v1/auth/password/reset

ParameterDescription
email stringUser’s email from the reset link.
password stringNew password (min. 8 characters, must include letters and numbers).
passwordConfirmation stringMust match password.
token stringThe reset token received via email.

Response

204 No Content

Indicates the password reset was successful.

Error Handling

A bad request (invalid data, wrong or expired token) returns: 400 Bad Request

json
{
  "message": "Failed to reset password."
}