Request a password reset

A user can initialize password reset by providing his/hers email address.


Method Uri Auth Permissions
POST /v1/auth/password/email none none

Headers

The API requires a header Accept to be submitted with the request:

{
    "Accept": "application/json"
}

Data constraints

{
  "email": "required|email"
}

Success Responses

Condition : An existing email has been provided

Code : 200 Okay

{info} This will trigger an email notification

{
  "message": "We have emailed your password reset link!"
}

Error Responses

Condition : If email has not been provided.

Code : 422 Unprocessabke Entity

Content example :

{
  "message": "De opgegeven informatie bevat fouten.",
  "errors": {
    "email": [
      "The email field is required."
    ]
  }
}

Condition : If email has been provided but does not exist.

Code : 400 Bas Request

Content example :

{
  "message": "We can't find a user with that email address."
}