Skip to main content
View Markdown

requestEmailChange Mutation

Request email change of the logged in user.

Requires the AUTHENTICATED_USERpermission.

Triggers the following webhook events:

  • NOTIFY_USER (async): A notification for account email change.
  • ACCOUNT_CHANGE_EMAIL_REQUESTED (async): An account email change was requested.
requestEmailChange(
  channel: String
  newEmail: String!
  password: String!
  redirectUrl: String!
): RequestEmailChange
Details
type RequestEmailChange {
  user: User
  accountErrors: [AccountError!]! @deprecated
  errors: [AccountError!]!
}

Arguments​

channel ● String​

Slug of a channel which will be used to notify users. Optional when only one channel exists.

newEmail ● String!​

New user email.

password ● String!​

User password.

redirectUrl ● String!​

URL of a view where users should be redirected to update the email address. URL in RFC 1808 format.

Type​

RequestEmailChange​

Request email change of the logged in user.

Requires the AUTHENTICATED_USERpermission.

Triggers the following webhook events:

  • NOTIFY_USER (async): A notification for account email change.
  • ACCOUNT_CHANGE_EMAIL_REQUESTED (async): An account email change was requested.