Consumer Authentication

/

API reference

/

Magic links

/

Via email

/

Send magic link

Send Magic Link by email

POSThttps://test.stytch.com/v1/magic_links/email/send

Send a magic link to an existing Stytch user using their email address. If you'd like to create a user and send them a magic link by email with one request, use our log in or create endpoint.

Add an email to an existing user

This endpoint also allows you to add a new email address to an existing Stytch User. Including a user_id, session_token, or session_jwt in your Send Magic Link by email request will add the new, unverified email address to the existing Stytch User. If the user successfully authenticates within 5 minutes, the new email address will be marked as verified and remain permanently on the existing Stytch User. Otherwise, it will be removed from the User object, and any subsequent login requests using that email address will create a new User.

Next steps

The user is emailed a magic link which redirects them to the provided redirect URL. Collect the token from the URL query parameters, and call Authenticate magic link to complete authentication.


Body parameters


email*string

login_magic_link_urlstring

signup_magic_link_urlstring

login_expiration_minutesint

signup_expiration_minutesint

login_template_idstring

signup_template_idstring

localestring

attributesobject

code_challengestring

user_idstring

session_tokenstring

session_jwtstring

Response fields


status_codeint

request_idstring

user_idstring

email_idstring
curl --request POST \
  --url https://test.stytch.com/v1/magic_links/email/send \
  -u 'PROJECT_ID:SECRET' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "sandbox@stytch.com"
  }'

RESPONSE

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

Common Error Types