INPUT_OBJECT

CreateCommunityPointsCustomRewardInput

Input for creating a custom Community Points reward in a channel.

link GraphQL Schema definition

1input CreateCommunityPointsCustomRewardInput {
5
2# The optional custom background color for this reward.
3# Should be a hex color string, for example "FF0000".
4backgroundColor: String
8
6# The channel ID that the reward is being created in.
7channelID: ID!
11
9# The point cost of this reward.
10cost: Int!
14
12# The length of the global cooldown applied to rewards redeemed of this type.
13globalCooldownSetting: CommunityPointsCustomRewardGlobalCooldownSettingInput
17
15# Whether only subscribers are allowed to redeem this reward in this channel.
16isSubOnly: Boolean!
20
18# Whether this reward requires users to enter text input.
19isUserInputRequired: Boolean!
23
21# The most rewards of this type that can be redeemed per stream.
22maxPerStreamSetting: CommunityPointsCustomRewardMaxPerStreamSettingInput
26
24# The most rewards of this type that can be redeemed per user per stream.
25maxPerUserPerStreamSetting: CommunityPointsCustomRewardMaxPerUserPerStreamSettingInput
29
27# The optional user-facing prompt for this reward.
28prompt: String
34
30# Optional boolean for whether redemptions for this reward should skip the
31# broadcaster's
32# request queue and get automatically fulfilled. Defaults to false.
33shouldRedemptionsSkipRequestQueue: Boolean
38
35# The id for the CustomRewardTemplate this reward is being created from. Null if a
36# template wasn't used.
37templateID: ID
41
39# The short title displayed for this reward.
40title: String!
42}