POST /api/v2/users/password/reset
Request a password reset

Headers

Header name Description
Content-Type
required 		application/json
X-API-KEY
required 		YOUR_API_KEY

Params

Param name Description
email
required

Validations:

  • Must be a String

Examples

// When missing required parameters
POST /api/v2/users/password/reset
422
{
  "error": "Missing parameter email"
}
// Successful request
POST /api/v2/users/password/reset
{
  "email": "new-user-created@example.com"
}
200
{
  "ok": "Password reset instructions were sent to the given email if it is found in our system"
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters