Request password reset

POST

/password/forgot

const url = 'https://auth.timetonic.com/api/password/forgot';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"email":"hello@example.com"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://auth.timetonic.com/api/password/forgot \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com" }'

Send password reset email. Rate-limited via throttle:passwordReset (see the passwordReset named limiter in AppServiceProvider).

Request Body^required

application/json

object

email

required

string format: email

Example^generated

{
  "email": "hello@example.com"
}

Responses

200

Reset email sent (if account exists)

application/json

object

success

boolean

message

string

Example

{
  "success": true
}

429

Rate limit exceeded (throttle:passwordReset)

Request password reset

Request Bodyrequired

Examplegenerated

Responses

200

Example

429

Request Body^required

Example^generated