Skip to main content
POST
/
auth
/
forgot-password
Request password reset
curl --request POST \
  --url http://localhost:3000/auth/forgot-password \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com"
}
'
{
  "statusCode": 123,
  "message": "OK",
  "data": {
    "message": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-timezone
string

User timezone (e.g., America/New_York, UTC+1). Defaults to UTC.

Body

application/json
email
string<email>
required

Response

Default Response

statusCode
number
message
string
default:OK
data
object