Skip to main content

requestPasswordReset Mutation

Sends an email with the account password modification link.

Triggers the following webhook events:

  • NOTIFY_USER (async): A notification for password reset.
  • ACCOUNT_SET_PASSWORD_REQUESTED (async): Setting a new password for the account is requested.
  • STAFF_SET_PASSWORD_REQUESTED (async): Setting a new password for the staff account is requested.
requestPasswordReset(
  channel: String
  email: String!
  redirectUrl: String!
): RequestPasswordReset
Show return type

Arguments​

channel ● String​

Slug of a channel which will be used to notify the user. It is needed for customers, if not provided, the notification may not happen. Please note that mutation will not fail if the channel is not provided.

email ● String!​

Email of the user that will be used for password recovery.

redirectUrl ● String!​

URL of a view where users should be redirected to reset the password. URL in RFC 1808 format.

Type​

RequestPasswordReset​

Sends an email with the account password modification link.

Triggers the following webhook events:

  • NOTIFY_USER (async): A notification for password reset.
  • ACCOUNT_SET_PASSWORD_REQUESTED (async): Setting a new password for the account is requested.
  • STAFF_SET_PASSWORD_REQUESTED (async): Setting a new password for the staff account is requested.