Docmost Octri Preview
POST/auth/forgot-password

Request a password reset email

Requests a password reset email for an account. Supply the account email address in email, using a valid email format. If the account exists, the response confirms the reset email was sent; no error is returned when it does not.

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

1 body field

Account email address for the password reset request.

emailstringrequired
Email address of the account. A reset link is sent if the account exists (no error if it doesn't).

2 status codes
200Returns a response confirming the reset email was sent if the account exists.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
400Returned when SSO is enforced or the request fails validation.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

email is required and must use a valid email format. A 400 is returned when SSO is enforced or the request fails validation.