OBJECT
CommunityPointsCustomReward
A custom community points reward on a channel.
link GraphQL Schema definition
1 type CommunityPointsCustomReward { 2 3 # The custom background color for this reward. If no background color specified, 4 # will be null. 5 : 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. 11 : Time 12 13 # The point cost of this reward. 14 : Int! 15 16 # The default image for community points custom rewards. 17 : CommunityPointsImage! 18 19 # The most rewards of this type that can be redeemed per the global cooldown. 20 : CommunityPointsCustomRewardGlobalCooldownSetting! 21 22 # Whether this reward has real world value. Null if the broadcaster has not set 23 # this field yet. 24 : Boolean 25 26 # The unique identifier for this reward. 27 : ID! 28 29 # The custom image for this reward. If no image exists, will be null. 30 : CommunityPointsImage 31 32 # Whether this reward is enabled in this channel at the moment. 33 : 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. 38 : Boolean! 39 40 # Whether redemptions of this reward are temporarily paused. 41 : Boolean! 42 43 # Whether only subscribers are allowed to redeem this reward in this channel. 44 : Boolean! 45 46 # Whether this reward requires users to enter text input. 47 : Boolean! 48 49 # The most rewards of this type that can be redeemed per stream. 50 : CommunityPointsCustomRewardMaxPerStreamSetting! 51 52 # The most rewards of this type that can be redeemed per user per stream. 53 : CommunityPointsCustomRewardMaxPerUserPerStreamSetting! 54 55 # The user-facing prompt for this reward. If no prompt exists, will be null. 56 : 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. 61 : Int 62 63 # Whether redemptions for this reward should skip the broadcaster's request queue 64 # and get 65 # automatically fulfilled. 66 : Boolean! 67 68 # The id for the CustomReward template this reward was created from. Will be null 69 # if not created from a template. 70 : ID 71 72 # The short title displayed for this reward. 73 : String! 74 75 # Time that this reward was last updated in a way that should show a new content 76 # indicator to viewers. 77 : Time! 78 79 }
link Required by
- CommunityPointsChannelSettingsSettings for a channel's Community Points.
- CommunityPointsCustomRewardRedemptionA community points custom reward that has been redeemed in a channel.
- CommunityPointsCustomRewardUserRedemptionCustom reward user redemption.
- CommunityPointsRewardSummaryA summary of information about redemptions of a given custom community points reward. Only returns results for logged-in, authorized users, otherwise returns a nil response.
- CreateCommunityPointsCustomRewardPayloadThe response from creating a custom Community Points reward in a channel.
- DeleteCommunityPointsCustomRewardPayloadThe response from deleting a custom Community Points reward in a channel.
- UpdateCommunityPointsCustomRewardPayloadThe response from updating a custom Community Points reward in a channel.