Password Reset Request

POST /user/password-reset/

Use the POST /user/password-reset/ endpoint to request a password reset. A reset link will be sent to the provided email address.


Parameters

Name

Type

Location

Description

Required

data

Object

Body

Request body containing details for the password reset.

Yes

email

String

Body

Email address of the user requesting a password reset. Must be a valid email.

Yes

redirect_url

String

Body

URL to redirect the user after completing the password reset process.

Yes


Request Body Example

{
  "email": "user@example.com",
  "redirect_url": "https://example.com/reset-success"
}

Responses

201 Created

Password reset request successfully initiated.

Response Example:

{
  "email": "user@example.com",
  "redirect_url": "https://example.com/reset-success"
}

Last updated