Skip to main content

triggerPasswordSendResetEmailEvent

Trigger password reset email notification.

Initiates the process to send a password reset email to the specified user. The email contains a secure link that allows the user to reset their password. This mutation can be called without authentication.

Possible errors:

  • GENERATE_PASSWORD_RECOVERY_LINK_ERROR: Failed to generate password recovery link
  • TRIGGER_SEND_PASSWORD_RESET_EVENT_ERROR: Failed to trigger password reset email

AUTH: Role=[user.OWNER] OR ('undefined')

triggerPasswordSendResetEmailEvent(
  input: PasswordRecoveryLinkInput!
): Boolean!

Arguments​

triggerPasswordSendResetEmailEvent.input ● PasswordRecoveryLinkInput! non-null input​

Password reset email parameters including user email and optional redirect URL.

Contains the email address of the user requesting password reset and optional customization parameters.

Type​

Boolean scalar​

The Boolean scalar type represents true or false.