@playlive/react-query
    Preparing search index...

    Function useLeaderboardExclusions

    • Read + mutate the donor-name exclusion list for a campaign against the Play Live leaderboard API.

      Composes:

      • useQuery on GET /leaderboard-exclusions/{id} for the read.
      • useMutation on POST / DELETE for addExclusion / removeExclusion; success invalidates the read query so the UI picks up the new list without polling.

      Auth: the mutations accept an admin API key or a Tiltify OAuth token via LeaderboardAuthOptions. Pass whichever your overlay has — admins provide adminApiKey, campaign-owner clients provide tiltifyOAuthToken. The GET is public.

      Auto-disables when campaignID is nullish or empty.

      Parameters

      Returns UseLeaderboardExclusionsResult

      const { donorNames, addExclusion, removeExclusion, isMutating } =
      useLeaderboardExclusions(
      { campaignID },
      { adminApiKey: process.env.ADMIN_KEY },
      );