Reset by email start

The resetByEmailStart method wraps the Reset By Email Start Password API endpoint. This endpoint initiates a password reset for the email address provided. This will trigger an email to be sent to the address, containing a magic link that will allow them to set a new password and authenticate.

Method parameters

email* string

Configuration object

Additional configuration.

reset_password_redirect_url string

login_redirect_url string

reset_password_expiration_minutes int

reset_password_template_id string

Response fields

request_id string

status_code int

user_id string

email_id string

import React, { useCallback } from 'react';
import { useStytch } from '@stytch/react';

export const Login = () => {
  const stytch = useStytch();

  const resetPasswordStart = useCallback(() => {
    stytch.passwords.resetByEmailStart({
      email: '${exampleEmail}',
    });
  }, [stytch]);

  return <button onClick={resetPasswordStart}>Reset Password Start</button>;
};

RESPONSE

{
    "status_code": 200,
    "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
    "user_id": "user-test-16d9ba61-97a1-4ba4-9720-b03761dc50c6",
    "email_id": "email-test-81bf03a8-86e1-4d95-bd44-bb3495224953"
}