Password Reset By Email Start
Initiate a password reset by email.
Authorizations
Body
Request type
The URL that the User is redirected to from the reset password magic link. This URL should display your application's reset password page.
Before rendering the reset page, extract the token from the query parameters. On the reset page, collect the new password and complete the flow by calling the corresponding Password Reset by Email endpoint.
If this parameter is not specified, the default Reset Password redirect URL configured in the Dashboard will be used. If you have not set a default Reset Password redirect URL, an error is returned.
Used to determine which language to use when sending the user this delivery method. Parameter is an IETF BCP 47 language tag, e.g. "en".
If no value is provided, the copy defaults to English.
en, es, pt-br, fr 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
Successful response