Skip to main content

accountRequestDeletion Mutation

Sends an email with the account removal link for the logged-in user.

Requires the AUTHENTICATED_USERpermission.

Triggers the following webhook events:

  • NOTIFY_USER (async): A notification for account delete request.
  • ACCOUNT_DELETE_REQUESTED (async): An account delete requested.
accountRequestDeletion(
  channel: String
  redirectUrl: String!
): AccountRequestDeletion
Show return type

Arguments​

channel ● String​

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

redirectUrl ● String!​

URL of a view where users should be redirected to delete their account. URL in RFC 1808 format.

Type​

AccountRequestDeletion​

Sends an email with the account removal link for the logged-in user.

Requires the AUTHENTICATED_USERpermission.

Triggers the following webhook events:

  • NOTIFY_USER (async): A notification for account delete request.
  • ACCOUNT_DELETE_REQUESTED (async): An account delete requested.