STstytch
Email

Send

Changed on

Send a discovery magic link to an email address. The magic link is valid for 60 minutes.

post/v1/b2b/magic_links/email/discovery/send

Request

  • Base URL
    https://api.stytch.com
  • Auth
    HTTP basic

Request body

email_addressstring required

The email address of the Member.

discovery_redirect_urlstring

The URL that the end user clicks from the discovery Magic Link. This URL should be an endpoint in the backend server that verifies the request by querying Stytch's discovery authenticate endpoint and continues the flow. If this value is not passed, the default discovery redirect URL that you set in your Dashboard is used. If you have not set a default discovery redirect URL, an error is returned.

pkce_code_challengestring

A base64url encoded SHA256 hash of a one time secret used to validate that the request starts and ends on the same device.

login_template_idstring

Use a custom template for discovery 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 “Magic Links - Login”.

locale'en' | 'es' | 'pt-br' | 'fr'
discovery_expiration_minutesinteger

The expiration time, in minutes, for an discovery magic link email. If not accepted within this time frame, the email will need to be resent. Defaults to 60 (1 hour) with a minimum of 5 and a maximum of 10080 (1 week).

Response

Successful response

request_idstring required

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_codeinteger required

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.

Changes