Start Password reset by email

POSThttps://test.stytch.com/v1/passwords/email/reset/start

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.


Body parameters


email*string

reset_password_redirect_urlstring

login_redirect_urlstring

reset_password_expiration_minutesint

reset_password_template_idstring

localestring

attributesobject

code_challengestring

Response fields


status_codeint

request_idstring

user_idstring

email_idstring
curl --request POST \
  --url https://test.stytch.com/v1/passwords/email/reset/start \
  -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"
}