Sign in
Authentication

Request password reset

Send the user an email with instructions to reset their password. Used when the password was forgotten or never set.

Copy as Markdown Open in ChatGPT Open in Claude

put/v1/authentication/request-password-reset

Request body

emailstring email required

Example request

{
  "email": "user@example.com"
}

Response

Reset email sent

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": {
    "email": "user@example.com"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.