requestPasswordReset

POST

/request-password-reset

curl --request POST \
  --url https://gymgym.club/api/auth/request-password-reset \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example", "redirectTo": "example" }'

Send a password reset email to the user

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

email

required

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

string

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

string

Example^generated

{
  "email": "example",
  "redirectTo": "example"
}

Responses

200

Success

Media typeapplication/json

object

status

boolean

message

string

Example^generated

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

400

Bad Request. Usually due to missing parameters, or invalid parameters.

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

401

Unauthorized. Due to missing or invalid authentication.

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

403

Forbidden. You do not have permission to access this resource or to perform this action.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

404

Not Found. The requested resource was not found.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

429

Too Many Requests. You have exceeded the rate limit. Try again later.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

500

Internal Server Error. This is a problem with the server that you cannot fix.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}