Reset by Email Start - Stytch Docs

import { 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>;
};

{
    "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"
}

import { 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>;
};

{
    "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"
}

import { 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>;
};

{
    "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"
}

The passwords.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.

Parameters

string

required

The email of the user.

Configuration

object

Additional configuration.

Show properties

reset_password_redirect_url

string

The url that the user clicks from the password reset email to finish the reset password flow. This should be a url that your app receives and parses before showing your app’s reset password page. After the user submits a new password to your app, it should send an API request to complete the password reset process. If this value is not passed, the default reset password redirect URL that you set in your Dashboard is used. If you have not set a default reset password redirect URL, an error is returned.

The URL that Users are redirected to upon clicking the “Log in without password” button in password reset emails. After Users are redirected to the login redirect URL, your application should retrieve the token value from the URL parameters and call the Magic Link Authenticate endpoint to log the User in without requiring a password reset. If this value is not provided, your project’s default login redirect URL will be used. If you have not set a default login redirect URL, an error will be returned.

reset_password_expiration_minutes

int

Set the expiration for the password reset, in minutes. By default, it expires in 30 minutes. The minimum expiration is 5 minutes and the maximum is 7 days (10080 mins).

reset_password_template_id

string

Use a custom template for password reset emails. By default, it will use your default email template. Templates can be added in the Stytch dashboard using our built-in customization options or custom HTML templates with type “Passwords - Password reset”.

Response

user_id

string

The unique ID of the affected User.

email_id

string

The unique ID of a specific email address.

request_id

string

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.

status_code

number

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.

⌘I

​Parameters

​Response

Parameters

Response