Headers

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

Params

Param name Description
password
required

Validations:

  • Must be a String

password_confirmation
required

Validations:

  • Must be a String

reset_password_token
required

Validations:

  • Must be a String

Examples

// Passwords not matching
PUT /api/v2/users/password
{
  "password": "coMplexEnoughButNotMatching!",
  "password_confirmation": "OopsieWoopsieNotMatching123",
  "reset_password_token": "fojoiZtvYZXLBovyRrsF"
}
400
{
  "error": {
    "password_confirmation": [
      "doesn't match Password"
    ]
  }
}
// Weak password
PUT /api/v2/users/password
{
  "password": "weakpass",
  "password_confirmation": "weakpass",
  "reset_password_token": "xn_m169WGZ_DV5PejrKu"
}
400
{
  "error": {
    "password": [
      "not strong enough. It scored 1. It must score at least 3."
    ]
  }
}
// Invalid reset_password_token
PUT /api/v2/users/password
{
  "password": "pAssWoRd!112345",
  "password_confirmation": "pAssWoRd!112345",
  "reset_password_token": "hulabaloo"
}
400
{
  "error": {
    "reset_password_token": [
      "is invalid"
    ]
  }
}
// Successful request
PUT /api/v2/users/password
{
  "password": "SamuLinV3rhot!",
  "password_confirmation": "SamuLinV3rhot!",
  "reset_password_token": "mtS9ukGV5qTx_exCSx6u"
}
200
{
  "ok": "Password was reset successfully"
}

Errors

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