requestEmailChange Mutation

Request email change of the logged in user.

Requires one of the following permissions:AUTHENTICATED_USER

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.

Applied directives

@webhookEventsInfo(asyncEvents: [NOTIFY_USER, ACCOUNT_CHANGE_EMAIL_REQUESTED], syncEvents: [])

requestEmailChange(channel: String, newEmail: String!, password: String!, redirectUrl: String!): RequestEmailChange

Returns

RequestEmailChange

Show return type

type RequestEmailChange {
  user: User
  accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
  errors: [AccountError!]!
}

Arguments

channel

channel · String

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

newEmail

newEmail · String!

New user email.

password

password · String!

User password.

redirectUrl

redirectUrl · String!

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

Schema: Saleor 3.23.43. Download SDL.