Start Password reset by email

POST
https://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_url string
login_redirect_url string
reset_password_expiration_minutes int
reset_password_template_id string
locale string
attributes object
code_challenge string

Response fields

status_code int
request_id string
user_id string
email_id string
const stytch = require('stytch');

const client = new stytch.Client({
  project_id: 'PROJECT_ID',
  secret: 'SECRET',
});

const params = {
  email: "sandbox@stytch.com",
};

client.passwords.email.resetStart(params)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });
RESPONSE
{
  "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