Skip to main content

requestEmailChange Mutation

Request email change of the logged in user.

Requires 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

Arguments​

requestEmailChange.channel ● String scalar miscellaneous​

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

requestEmailChange.newEmail ● String! non-null scalar miscellaneous​

New user email.

requestEmailChange.password ● String! non-null scalar miscellaneous​

User password.

requestEmailChange.redirectUrl ● String! non-null scalar miscellaneous​

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

Type​

RequestEmailChange object users​

Request email change of the logged in user.

Requires 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.