Skip to main content

adminUserPreferenceDelete

Delete a preference of an administrative user.

Permanently removes the preference. This action cannot be undone. With a role, the preference of any admin user can be deleted.

Possible errors:

  • ADMIN_USER_PREFERENCE_NOT_FOUND_ERROR: No such preference, or it belongs to another admin user
  • ADMIN_USER_PREFERENCE_AUTH_ERROR: The request neither identifies an admin user nor carries a role
  • ADMIN_USER_PREFERENCE_DELETE_ERROR: Error occurred while deleting the preference

AUTH: Role=[user.OWNER] OR ('user is authenticated')

adminUserPreferenceDelete(
  id: ID!
): Boolean!

Arguments​

adminUserPreferenceDelete.id ● ID! non-null scalar​

Unique identifier of the preference to delete.

Type​

Boolean scalar​

The Boolean scalar type represents true or false.