OBJECT

CommunityPointsCustomRewardTemplate

A template used to create a custom reward.

link GraphQL Schema definition

1type CommunityPointsCustomRewardTemplate {
2
3# The custom background color for a reward created from this template.
4backgroundColor: String!
5
6# The point cost for a reward created from this template.
7cost: Int!
8
9# The maximum number of redemptions for the reward created from this
10# template that can be redeemed per the global cooldown.
11globalCooldownSetting: CommunityPointsCustomRewardGlobalCooldownSetting!
12
13# The unique identifier for this reward template.
14id: ID!
15
16# The default image for a reward created from this template.
17image: CommunityPointsImage!
18
19# Whether only subscribers are allowed to redeem the reward created
20# from this template.
21isSubOnly: Boolean!
22
23# Whether the reward created from this template requires users to enter
24# text input.
25isUserInputRequired: Boolean!
26
27# The maximum number of redemptions for the reward created from this
28# template that can be redeemed per stream.
29maxPerStreamSetting: CommunityPointsCustomRewardMaxPerStreamSetting!
30
31# The maximum number of redemptions for the reward created from this
32# template that can be redeemed per user per stream.
33maxPerUserPerStreamSetting: CommunityPointsCustomRewardMaxPerUserPerStreamSetting!
34
35# The user-facing prompt for the reward created from this template.
36# If no prompt exists, will be null.
37prompt: String
38
39# Whether redemptions for the reward created from this template should
40# skip the broadcaster's request queue and get automatically fulfilled.
41shouldRedemptionsSkipRequestQueue: Boolean!
42
43# The short title displayed for the reward created from this template.
44title: String!
45
46}