Docmost Octri Preview
POST/auth/password-reset

Reset a password using a token

Resets a user's password using a one-time token from a password reset email. Provide the token in token and the replacement password in newPassword. The new password must be at least 8 characters long.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields

One-time password reset token and replacement password.

newPasswordstringrequired
New password. Must be at least 8 characters.
tokenstringrequired
One-time password reset token from the email link.

3 status codes
200Returns a response confirming that the password was reset.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
400Returned when the reset token is invalid or expired.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the user is not found.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned when token is invalid or expired. A 404 is returned when the user is not found. Both token and newPassword are required, and newPassword must be at least 8 characters.