INPUT_OBJECT

UpdateCommunityPointsCustomRewardInput

Input for updating a custom Community Points reward in a channel. Only the channelID and rewardID are required. All other fields are optional. Only set fields that are intended to be updated.

link GraphQL Schema definition

1input UpdateCommunityPointsCustomRewardInput {
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 updated 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 this reward has real world value.
16hasRealWorldValue: Boolean
20
18# Whether the reward is enabled.
19isEnabled: Boolean
23
21# Whether the reward is temporarily paused.
22isPaused: Boolean
26
24# Whether only subscribers are allowed to redeem this reward in this channel.
25isSubOnly: Boolean
29
27# Whether this reward requires users to enter text input.
28isUserInputRequired: Boolean
32
30# The most rewards of this type that can be redeemed per stream.
31maxPerStreamSetting: CommunityPointsCustomRewardMaxPerStreamSettingInput
35
33# The most rewards of this type that can be redeemed per user per stream.
34maxPerUserPerStreamSetting: CommunityPointsCustomRewardMaxPerUserPerStreamSettingInput
38
36# The optional user-facing prompt for this reward.
37prompt: String
41
39# The ID of the reward being updated.
40rewardID: ID!
46
42# Whether redemptions for this reward should skip the broadcaster's request queue
43# and get
44# automatically fulfilled.
45shouldRedemptionsSkipRequestQueue: Boolean
49
47# A flag to reset this custom reward's image to the default.
48shouldResetImage: Boolean
52
50# The short title displayed for this reward.
51title: String
53}