Channel Point Rewards
On this page
Creates a Channel Point Reward on Twitch that will be owned by SAMMI. Only rewards owned by SAMMI can be further modified from within SAMMI.
This is an Async (Purple) Command, which operates differently from standard commands.
| Box Name | Type | Description |
|---|---|---|
| Login Name | Dropdown | Your Twitch login name (all lowercase characters) |
| Title | String | What you want to name your new reward. |
| Cost | Number | How much you want the reward to cost. You can use variables. |
| Color | Color Picker | Display colour of the reward on Twitch. |
| Input | Checkbox | If enabled, requires a viewer’s input. |
| Description | String | Description of the reward. |
| Save ID Variable As | String | Variable to save the reward ID as. |
| Enabled | Checkbox | Whether you want to enable the reward after creation. |
Saved Value:
| Value | Type | Description |
|---|---|---|
| savedVariable | String | ID of the newly created Channel Point Reward. |
| ”” | String | Saved as an empty string if Twitch does not return a reward ID. |
| undefined | Undefined | Saved if the Twitch account cannot be resolved or the required scope is missing. |
Twitch API Endpoint: POST /helix/channel_points/custom_rewards
| Request Field | Type | Description |
|---|---|---|
| broadcaster_id | string | The ID of the broadcaster to add the custom reward to. |
| title | string | The custom reward’s title. |
| cost | integer | The cost of the reward, in channel points. |
| is_enabled | boolean | Whether the reward is enabled. |
| background_color | string | The background color to use for the reward (in Hex color code format, e.g. #9147FF). |
| is_user_input_required | boolean | Whether the user needs to enter information when redeeming the reward. |
| prompt | string | The prompt shown to the viewer when they redeem the reward. |
Updates a Custom Channel Points Reward created on your channel.
You can only edit rewards that were previously created with SAMMI (you can verify it says 'Owned' in Twitch Connections - Edit Rewards window, and dupe it if needed)
| Box Name | Type | Description |
|---|---|---|
| Login Name | Dropdown | Your Twitch login name (all lowercase characters) |
| Reward (ID required) | Dropdown | ID of the custom reward to update. You can select it from the dropdown menu or type manually. |
| Name | String | The title of the reward |
| Cost | Number | The cost of the reward |
| Enabled | Checkbox | If the reward is currently enabled or not. If not enabled, the reward won’t show up to viewers. |
| Pause | Checkbox | If the reward is currently paused. If paused, viewers cannot redeem it. |
Twitch API Endpoint: PATCH /helix/channel_points/custom_rewards
| Request Field | Type | Description |
|---|---|---|
| broadcaster_id | string | The ID of the broadcaster that owns the custom reward. |
| id | string | The ID of the reward to update. |
| title | string | The reward’s title. |
| cost | integer | The cost of the reward, in channel points. |
| is_enabled | boolean | Whether the reward is enabled. |
| is_paused | boolean | Whether the reward is currently paused. |
Updates a Custom Channel Points Reward created on your channel, allowing you to change additional settings that are not accessible from the regular Edit Reward command (see above).
You can only edit rewards that were previously created with SAMMI (you can verify it says 'Owned' in Twitch Connections - Edit Rewards window, and dupe it if needed)
| Box Name | Type | Description |
|---|---|---|
| Login Name | Dropdown | Your Twitch login name (all lowercase characters). Leave empty for your default streamer account. |
| Reward (ID required) | Dropdown | ID of the custom reward to update. |
| Description | String | Description of the reward. |
| Color | Color Picker | Display colour of the reward on Twitch. |
| User Input | Checkbox | If enabled, requires a viewer’s input. |
| Skip Queue | Checkbox | If enabled, allows the redemption to skip the queue. |
| Cooldown (s) | Number | Amount of seconds the reward will be on a cooldown. |
| Max/User | Number | Number of allowed redemptions per user. |
| Max/Stream | Number | Number of allowed redemptions per stream. |
Twitch API Endpoint: PATCH /helix/channel_points/custom_rewards
| Request Field | Type | Description |
|---|---|---|
| broadcaster_id | string | The ID of the broadcaster that owns the custom reward. |
| id | string | The ID of the reward to update. |
| prompt | string | The prompt shown to the viewer when they redeem the reward. |
| background_color | string | The background color to use for the reward (in Hex color code format, e.g. #9147FF). |
| is_user_input_required | boolean | Whether the user needs to enter information when redeeming the reward. |
| should_redemptions_skip_request_queue | boolean | Whether redemptions should be immediately fulfilled. |
| global_cooldown_seconds | integer | The cooldown period in seconds between redemptions. |
| max_per_user_per_stream | integer | Maximum number of redemptions allowed per user per stream. |
| max_per_stream | integer | Maximum number of redemptions allowed per stream. |
Updates all custom channel point rewards on your channel.
You can only edit rewards that were previously created with SAMMI (you can verify it says 'Owned' in Twitch Connections - Edit Rewards window, and dupe it if needed)
| Box Name | Type | Description |
|---|---|---|
| Login Name | Dropdown | Your Twitch login name (all lowercase characters) |
| Enabled | Dropdown | If the rewards are currently enabled or not. If not enabled, the rewards won’t show up to viewers. |
| Pause | Dropdown | If the rewards are currently paused. If paused, viewers cannot redeem them. |
Twitch API Endpoint: PATCH /helix/channel_points/custom_rewards
| Request Field | Type | Description |
|---|---|---|
| broadcaster_id | string | The ID of the broadcaster that owns the custom rewards. |
| id | string | The ID of each reward to update (called once per reward). |
| is_enabled | boolean | Whether the reward is enabled. |
| is_paused | boolean | Whether the reward is currently paused. |
Deletes your previously created reward.
You can only delete rewards that were previously created with SAMMI (you can verify it says 'Owned' in Twitch Connections - Edit Rewards window, and dupe it if needed)
| Box Name | Type | Description |
|---|---|---|
| Login Name | Dropdown | Your Twitch login name (all lowercase characters) |
| Reward (ID required) | Dropdown | ID of the custom reward to delete. |
Twitch API Endpoint: DELETE /helix/channel_points/custom_rewards
| Request Field | Type | Description |
|---|---|---|
| broadcaster_id | string | The ID of the broadcaster that owns the custom reward. |
| id | string | The ID of the custom reward to delete. |
Updates the status of custom reward redemption that has UNFULFILLED status.
You can only update rewards that were previously created with SAMMI (you can verify it says 'Owned' in Twitch Connections - Edit Rewards window, and dupe it if needed)
| Box Name | Type | Description |
|---|---|---|
| Login Name | Dropdown | Your Twitch login name (all lowercase characters) |
| Reward (ID required) | Dropdown | ID of the custom reward to change the status. You can select it from the dropdown menu or type manually. |
| Redeem ID | String | ID of the Custom Reward Redemption to update |
| Status | Dropdown | The new status to set redemptions to. Can be either FULFILLED or CANCELED. Updating to CANCELED will refund the user their channel points. |
Twitch API Endpoint: PATCH /helix/channel_points/custom_rewards/redemptions
| Request Field | Type | Description |
|---|---|---|
| broadcaster_id | string | The ID of the broadcaster that owns the custom reward. |
| reward_id | string | The ID of the custom reward the redemption belongs to. |
| id | string | The ID of the redemption to update. |
| status | string | The status to set the redemption to. Possible values: FULFILLED, CANCELED. |