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

Arguments

requestPasswordReset.channel ● String scalar miscellaneous

Slug of a channel which will be used for notify user. Optional when only one channel exists.

requestPasswordReset.email ● String! non-null scalar miscellaneous

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

requestPasswordReset.redirectUrl ● String! non-null scalar miscellaneous

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

Type

RequestPasswordReset object users

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.