deactivateAccount

Overview

This mutation deactivates the current logged in account if given the correct password.

Special Considerations

  • Must be logged in to an account before calling this mutation.
  • Must input the correct password for the current account.
  • Must supply a reason (a string) for deactivating.

Inputs

DeactivateAccountArgs

Required Data

password: string reason: string

Returns

Promise<SuccessResult>

A promise containing the following data:

message: string

Example

Running this mutation:

mutation {
  deactivateAccount (password: "Testing1"
  reason: "Testing purposes.") {
    message
  }
}

Gives us:

{
  "data": {
    "deactivateAccount": {
    "message": "Your account has been deactivated."
    }
  }
}

Common Errors

When running this mutation some of the common errors encountered include:

  • The password you entered is incorrect. (E-7004)
    • Please enter the correct password to deactivate your account.
← createLoginPersonAndAccountresendEmailVerification →