Sign in
auth
internal

post/api/auth/forgot-password

Request body

emailstring email required

Email address to send the password-reset link to.

Response

Password reset email sent

dataTupleUnit

No payload. Present only so the envelope keeps its shape.

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.13"
  }
}

Changes