@playlive/fundraiser-data
    Preparing search index...

    Interface UpdateRulesetParams

    Params for updateRuleset.

    interface UpdateRulesetParams {
        adminApiKey?: string;
        campaignID?: string;
        ruleset: DonationTrainRuleset;
        signal?: AbortSignal;
        tiltifyOAuthToken?: string;
    }

    Hierarchy (View Summary)

    Index
    adminApiKey? campaignID? ruleset signal? tiltifyOAuthToken?
    adminApiKey?: string

    Shared admin API key sent as x-api-key.

    campaignID?: string

    When set, the request is routed through the campaign-scoped route (PATCH /campaign-rulesets/{campaignID}/{rulesetID}) which supports both admin key and Tiltify OAuth auth. When omitted the fetcher hits the admin-only PATCH /rulesets/{rulesetID} route, preserving the historical server-to-server behavior.

    OAuth callers must set both this and tiltifyOAuthToken. The server derives the true owning campaignID from the ruleset row for the ownership check, so a mismatched path value only affects routing.

    ruleset: DonationTrainRuleset

    Full ruleset payload — the server keys off ruleset.id.

    signal?: AbortSignal

    Cancel on React unmount / other lifecycle events.

    tiltifyOAuthToken?: string

    Tiltify OAuth token sent as Authorization: OAuth <token>.

    Settings
    Member Visibility

    On This Page
    Properties