Skip to main content
POST
Send a password reset link

Body

application/json

Email of the admin user requesting the reset link.

email
string<email>
required

Email address of the admin user. Validator rule: required|email.

Example:

"user@example.com"

Response

Reset link queued for delivery (or silently dropped if the email is not registered).

message
string

Translated message from the password broker (e.g. passwords.sent).

Example:

"We have emailed your password reset link."

status
string
Example:

"success"