Interface CreateCampaignRulesetParams

Params for createCampaignRuleset.

interface CreateCampaignRulesetParams {
    adminApiKey?: string;
    campaignID: string;
    ruleset: PartialDonationTrainRuleset;
    signal?: AbortSignal;
    tiltifyOAuthToken?: string;
}

Hierarchy (View Summary)

DonationTrainAuthOptions
- CreateCampaignRulesetParams

Index

Properties

adminApiKey? campaignID ruleset signal? tiltifyOAuthToken?

Properties

`Optional`adminApiKey

adminApiKey?: string

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

campaignID

campaignID: string

Tiltify campaign ID to attach the new ruleset to.

ruleset

ruleset: PartialDonationTrainRuleset

Ruleset payload — the server assigns id + echoes campaignID.

`Optional`signal

signal?: AbortSignal

Cancel on React unmount / other lifecycle events.

`Optional`tiltifyOAuthToken

tiltifyOAuthToken?: string

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