Consumer Authentication

/

Frontend SDKs

/

Headless

/

Email Magic Links

/

Send

Send

The Send method wraps the send Email Magic Link API endpoint. This method requires that the user already exist within Stytch before a magic link may be sent. This method is useful for gating your login flow to only pre-created users, e.g. an invite or waitlist.

This method is also used when you need to add an email address to an existing Stytch User. If there is a currently valid Stytch session, and the user inputs an email address that does not match one on their Stytch User object, upon successful authentication the new email address will be appended to the emails array. Note, this does expose a potential account enumeration vector, see our article on preventing account enumeration for more details.

Method parameters

email* string
Configuration object

Additional configuration.

login_magic_link_url string
signup_magic_link_url string
login_expiration_minutes int
signup_expiration_minutes int
login_template_id string
signup_template_id string
locale string

Response fields

request_id string
status_code int
import { useStytch } from '@stytch/react';

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

  const sendEmailMagicLink = () => {
    stytch.magicLinks.email.send('sandbox@stytch.com', {
      login_magic_link_url: 'https://example.com/authenticate',
      login_expiration_minutes: 5,
    });
  };

  return <button onClick={sendEmailMagicLink}>Send email</button>;
};

RESPONSE

200
{
    "status_code": 200,
    "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141"
}