users_delete_all
Last edit: Nov 10, 2026
Soft deletes all users that match the filter and returns their number. The
users are marked as deleted immediately; the rest of the deletion runs in a
background job unless sync is true
users_delete_all(
all_users: Boolean
filter: UsersFilterInput
sync: Boolean
): ObjectCount!
Arguments
all_users (Boolean)
Must be true to delete all users when no filter is given
filter (UsersFilterInput)
Conditions the deleted users must match
sync (Boolean)
When true, the deletion finishes before the mutation returns instead of in a background job
Type
ObjectCount
Result of a bulk operation