Channel Point Rewards

On this page

Edit

Create Reward #

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.

Edit

Edit Reward #

Updates a Custom Channel Points Reward created on your channel. All fields are optional — leave any field empty (or set to No Change) to keep the current value.

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
Reward (ID required)	Dropdown	ID of the custom reward to update. Select from the dropdown or enter manually.
Channel Name	Dropdown	Your Twitch login name. Leave empty to use your default streamer account.
Name	String	The new title of the reward. Leave empty for no change. (max 45 characters)
Cost	Number	The new cost in channel points. Leave empty for no change.
Enabled	Dropdown	Enable or disable the reward. No Change keeps the current state.
Pause	Dropdown	Pause or unpause the reward. No Change keeps the current state.
Input Required	Dropdown	Whether viewers must enter text when redeeming. No Change keeps the current state.
Skip Queue	Dropdown	Whether redemptions skip the fulfillment queue. No Change keeps the current state.
Set Color	Checkbox	If checked, updates the reward’s background color using the color picker below.
Background Color	Color Picker	New background color for the reward on Twitch. Only applied when Set Color is checked.
Cooldown (s)	Number	Global cooldown in seconds between any redemptions. Set to 0 to disable. Leave empty for no change.
Max/User	Number	Maximum redemptions per user per stream. Set to 0 to disable. Leave empty for no change.
Max/Stream	Number	Maximum redemptions per stream. Set to 0 to disable. Leave empty for no change.
Description	String	The prompt shown to viewers when redeeming. Leave empty for no change. (max 200 characters)
Save Variable As	String	Optional. Variable name to save the updated reward object returned by Twitch. Leave empty to skip saving.

If the Name or Description exceeds the character limit, SAMMI will show a warning and automatically truncate it before sending the request.

The optional Save Variable As output stores the full updated reward object returned by Twitch (the same fields listed below, such as id, title, cost, is_enabled, and background_color). Use the Get Object Variable command to read individual fields.

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.
prompt	string	The prompt shown to the viewer when they redeem the reward.
background_color	string	Background color in Hex format (e.g. `#9147FF`).
is_user_input_required	boolean	Whether the user needs to enter information when redeeming.
should_redemptions_skip_request_queue	boolean	Whether redemptions are immediately fulfilled.
global_cooldown_seconds	integer	Cooldown period in seconds between redemptions.
is_global_cooldown_enabled	boolean	Whether the global cooldown is active.
max_per_user_per_stream	integer	Maximum redemptions per user per stream.
is_max_per_user_per_stream_enabled	boolean	Whether the per-user limit is active.
max_per_stream	integer	Maximum redemptions per stream.
is_max_per_stream_enabled	boolean	Whether the per-stream limit is active.

Edit

Extra Edit Reward (Deprecated) #

This command is deprecated. Use [Edit Reward](twitch-edit-reward) instead, which combines all fields from both the old Edit Reward and Extra Edit Reward commands.

Edit

Edit All Rewards #

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.

Edit

Delete Reward #

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.

Edit

Update Redemption Status #

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`.