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_address* string

organization_id* string

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

member_id string

member_email_id string

member object

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

export const ResetPasswordStart = () => {
  const stytch = useStytchB2BClient();

  const resetPasswordStart = useCallback(() => {
    stytch.passwords.resetByEmailStart({
      email_address: 'sandbox@stytch.com',
      organization_id: 'organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931',
    });
  }, [stytch]);

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

RESPONSE

{
    "status_code": 200,
    "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
    "member_id": "member-test-32fc5024-9c09-4da3-bd2e-c9ce4da9375f",
    "member_email_id": "email-test-81bf03a8-86e1-4d95-bd44-bb3495224953",
    "member": {...}
}