Resets a user's password. Last step of the forgot password workflow process.

PUT /account/password/reset { "email": "{email}", "newPassword": "{new password}", "otp": "{otp}" }

PUT /account/password/reset { "email": "{email}", "newPassword": "{new password}", "pin": "{pin}" }

HTTP Status Code 400 Error Codes (error property):

MissingPropertyValue - Missing property value(s).

PasswordTooShort - The new password does not meet the minimum length requirement.

PasswordAlreadyUsed - The new password has already been used.

PasswordLacksComplexity - The new password does not meet complexity requirements.

InvalidPassword - The password could not be changed. Please ensure you are using the correct old password.

PasswordIsEmail - The new password cannot be the email address.

BothPinAndOtpProvided - Both the pin and otp were provided. Either pin or otp values are expected (not both).

HTTP Status Code 401 Error Codes (error property):

OtpExpired - The otp has expired.

OtpInvalid - The otp is invalid.

AccountLockedOut - Too many invalid login attempts. The account has been disabled.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Information required when attempting to reset your password after triggering the forgot password workflow (/password/forgot endpoint).

Information used to reset your password.

string

The user's email address.

string

A password the user prefers to change their password to.

string

A pin value that was sent via email (part of the emailed link).

string

A one time password (typically emailed to the user).

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json