Skip to main content

staffDelete Mutation

Deletes a staff user. Apps are not allowed to perform this mutation.

Requires the MANAGE_STAFFpermission.

Triggers the following webhook events:

  • STAFF_DELETED (async): A staff account was deleted.
staffDelete(
  id: ID!
): StaffDelete
Details
type StaffDelete {
  staffErrors: [StaffError!]! @deprecated
  errors: [StaffError!]!
  user: User
}

Arguments​

id ● ID!​

ID of a staff user to delete.

Type​

StaffDelete​

Deletes a staff user. Apps are not allowed to perform this mutation.

Requires the MANAGE_STAFFpermission.

Triggers the following webhook events:

  • STAFF_DELETED (async): A staff account was deleted.