SCscanopy
internal

Request password reset

Changed on
post/api/auth/forgot-password

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/auth/forgot-password
  • Auth
    none declared

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

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

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

Changes