OBJECT

CommunityPointsCustomReward

A custom community points reward on a channel.

link GraphQL Schema definition

1type CommunityPointsCustomReward {
2
3# The custom background color for this reward. If no background color specified,
4# will be null.
5backgroundColor: String
6
7# The cooldown expires at field indidicates when reward will be able to be
8# redeemed after the cooldown is set.
9# This field will only have a value if the global cooldown feature is enabled and
10# has been recently redeemed.
11cooldownExpiresAt: Time
12
13# The point cost of this reward.
14cost: Int!
15
16# The default image for community points custom rewards.
17defaultImage: CommunityPointsImage!
18
19# The most rewards of this type that can be redeemed per the global cooldown.
20globalCooldownSetting: CommunityPointsCustomRewardGlobalCooldownSetting!
21
22# Whether this reward has real world value. Null if the broadcaster has not set
23# this field yet.
24hasRealWorldValue: Boolean
25
26# The unique identifier for this reward.
27id: ID!
28
29# The custom image for this reward. If no image exists, will be null.
30image: CommunityPointsImage
31
32# Whether this reward is enabled in this channel at the moment.
33isEnabled: Boolean!
34
35# Whether this reward is in stock at the moment.
36# If the reward has already been redeemed the maximum number of times per stream,
37# this will be false.
38isInStock: Boolean!
39
40# Whether redemptions of this reward are temporarily paused.
41isPaused: Boolean!
42
43# Whether only subscribers are allowed to redeem this reward in this channel.
44isSubOnly: Boolean!
45
46# Whether this reward requires users to enter text input.
47isUserInputRequired: Boolean!
48
49# The most rewards of this type that can be redeemed per stream.
50maxPerStreamSetting: CommunityPointsCustomRewardMaxPerStreamSetting!
51
52# The most rewards of this type that can be redeemed per user per stream.
53maxPerUserPerStreamSetting: CommunityPointsCustomRewardMaxPerUserPerStreamSetting!
54
55# The user-facing prompt for this reward. If no prompt exists, will be null.
56prompt: String
57
58# The value of redemptions of the reward for the current stream.
59# This field will only have a value if the max per user per stream is enabled and
60# has been recently redeemed.
61redemptionsRedeemedCurrentStream: Int
62
63# Whether redemptions for this reward should skip the broadcaster's request queue
64# and get
65# automatically fulfilled.
66shouldRedemptionsSkipRequestQueue: Boolean!
67
68# The id for the CustomReward template this reward was created from. Will be null
69# if not created from a template.
70templateID: ID
71
72# The short title displayed for this reward.
73title: String!
74
75# Time that this reward was last updated in a way that should show a new content
76# indicator to viewers.
77updatedForIndicatorAt: Time!
78
79}