Request Password Reset

Send a password reset email to the user

Authorization

bearerAuth

AuthorizationBearer <token>

Bearer token authentication

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

The email address of the user to send a password reset email to

redirectTo?|

The URL to redirect the user to reset their password. If the token isn't valid or expired, it'll be redirected with a query parameter ?error=INVALID_TOKEN. If the token is valid, it'll be redirected with a query parameter `?token=VALID_TOKEN

Response Body

`application/json`

curl -X POST "https://example.com/request-password-reset" \  -H "Content-Type: application/json" \  -d '{    "email": "string"  }'

{  "status": true,  "message": "string"}

{  "message": "string"}

{  "message": "string"}

{  "message": "string"}

{  "message": "string"}

{  "message": "string"}

{  "message": "string"}

Request Password Reset

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`