/auth/get-password-reset-email/{email}

POST /auth/get-password-reset-email/{email}

Request a password reset email

Sends a password reset email with a reset token to the specified email address

Required Parameters

email path string

Email address to send the password reset link to

Try it out

Output:

Responses

Description

Password reset email sent successfully

{
  "message": "Password reset email sent to user@example.com"
}

Description

Bad request - invalid email format

{
  "error": "string",
  "status": 0,
  "message": "string"
}

Description

Not found - account with this email address does not exist

{
  "error": "string",
  "status": 0,
  "message": "string"
}

Description

Internal server error

{
  "error": "string",
  "status": 0,
  "message": "string"
}

References

#/components/schemas/Error

OpenAPI
TypeScript

type: object
properties:
  error:
    type: string
    description: Error message
  status:
    type: integer
    description: HTTP status code
  message:
    type: string
    description: Detailed error message
description: Error response object
required:
  - error

|
export interface Error {
  /** Error message */
  error: string;
  /** HTTP status code */
  status?: number;
  /** Detailed error message */
  message?: string;
}

Route Source Code

Check out the source code for this route entrypoint here: /auth/get-password-reset-email/[email]/route.ts

Or the swagger.yaml spec this documentation was generated from: /auth/get-password-reset-email/[email]/swagger.yaml