--- canonical_url: "https://docs.composio.dev/toolkits/twitch" markdown_url: "https://docs.composio.dev/toolkits/twitch.md" product: "platform" version: null last_updated: null --- # Twitch Twitch is a live streaming platform popular with gamers, creators, and communities, offering real-time interaction and monetization through subscriptions and donations - **Category:** video & audio - **Auth:** OAUTH2 - **Composio-managed OAuth available?** Yes - **Tools:** 131 - **Triggers:** 0 - **Slug:** `TWITCH` - **Version:** 20260915_00 ## Tools ### Add Blocked Term **Slug:** `TWITCH_ADD_BLOCKED_TERM` Adds a word or phrase to the broadcaster’s list of blocked terms. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `text` | string | Yes | The word or phrase to block from being used in the broadcaster’s chat room. The term must contain a minimum of 2 characters and may contain up to a maximum of 500 characters. Terms may include a wildcard character (*). The wildcard character must appear at the beginning or end of a word or set of characters. For example, *foo or foo*. If the blocked term already exists, the response contains the existing blocked term. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that owns the list of blocked terms. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Channel Moderator **Slug:** `TWITCH_ADD_CHANNEL_MODERATOR` Adds a moderator to the broadcaster’s chat room. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | The ID of the user to add as a moderator in the broadcaster’s chat room. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that owns the chat room. This ID must match the user ID in the access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Channel VIP **Slug:** `TWITCH_ADD_CHANNEL_VIP` Adds the specified user as a VIP in the broadcaster’s channel. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | The ID of the user to give VIP status to. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that’s adding the user as a VIP. This ID must match the user ID in the access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Suspicious Status to Chat User **Slug:** `TWITCH_ADD_SUSPICIOUS_STATUS_TO_CHAT_USER` Adds a suspicious user status to a chatter on the broadcaster’s channel. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `status` | string ("ACTIVE_MONITORING" | "RESTRICTED") | Yes | Suspicious-user status to apply: ACTIVE_MONITORING or RESTRICTED. | | `user_id` | string | Yes | The ID of the chatter receiving the suspicious-user status. | | `moderator_id` | string | Yes | The user ID of the moderator who is applying the status. | | `broadcaster_id` | string | Yes | The user ID of the broadcaster, indicating the channel where the status is being applied. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Assign Guest Star Slot **Slug:** `TWITCH_ASSIGN_GUEST_STAR_SLOT` BETA Allows a previously invited user to be assigned a slot within the active Guest Star session. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `slot_id` | string | Yes | The slot assignment to give to the user. Must be a numeric identifier between “1” and “N” where N is the max number of slots for the session. Max number of slots allowed for the session is reported by Get Channel Guest Star Settings . | | `guest_id` | string | Yes | The Twitch User ID corresponding to the guest to assign a slot in the session. This user must already have an invite to this session, and have indicated that they are ready to join. | | `session_id` | string | Yes | The ID of the Guest Star session in which to assign the slot. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user_id in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster running the Guest Star session. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Ban User **Slug:** `TWITCH_BAN_USER` Bans a user from participating in a broadcaster’s chat room or puts them in a timeout. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | object | Yes | Identifies the user and type of ban. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose chat room the user is being banned from. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Block User **Slug:** `TWITCH_BLOCK_USER` Blocks the specified user from interacting with or having contact with the broadcaster. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `reason` | string ("harassment" | "spam" | "other") | No | Optional reason for the block; omit it or specify harassment, spam, or other. | | `source_context` | string ("chat" | "whisper") | No | Context in which the block occurred: chat, whisper, or empty. | | `target_user_id` | string | Yes | ID of the user to block. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Cancel a raid **Slug:** `TWITCH_CANCEL_A_RAID` Cancel a pending raid. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `broadcaster_id` | string | Yes | The ID of the broadcaster that initiated the raid. This ID must match the user ID in the user access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Check AutoMod Status **Slug:** `TWITCH_CHECK_AUTOMOD_STATUS` Checks whether AutoMod would flag the specified message for review. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | array | Yes | The list of messages to check. The list must contain at least one message and may contain up to a maximum of 100 messages. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose AutoMod settings and list of blocked terms are used to check the message. This ID must match the user ID in the access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Check User Subscription **Slug:** `TWITCH_CHECK_USER_SUBSCRIPTION` Checks whether the user subscribes to the broadcaster’s channel. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | ID of the authenticated user whose subscription to check. | | `broadcaster_id` | string | Yes | ID of the broadcaster to check. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Channel Stream Schedule Segment **Slug:** `TWITCH_CREATE_CHANNEL_STREAM_SCHEDULE_SEGMENT` Adds a single or recurring broadcast to the broadcaster’s streaming schedule. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `title` | string | No | Broadcast title, up to 140 characters. | | `duration` | string | Yes | Scheduled duration in minutes, from 30 through 1380. | | `timezone` | string | Yes | Broadcast time zone in IANA format. | | `start_time` | string | Yes | Broadcast start time in RFC3339 format. | | `category_id` | string | No | Category ID for the broadcast content. | | `is_recurring` | boolean | No | Whether the broadcast recurs weekly. Only partners and affiliates may add non-recurring broadcasts. | | `broadcaster_id` | string | Yes | ID of the broadcaster that owns the schedule. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Request Clip Creation **Slug:** `TWITCH_CREATE_CLIP` Starts Twitch's asynchronous clip-creation process for a live stream. A 202 response is acceptance, not completed creation. Use GET_CLIPS with the returned ID to verify; if it is still absent after 60 seconds, Twitch says to assume creation failed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `title` | string | No | The title of the clip. | | `duration` | number | No | The length of the clip in seconds. Possible values range from 5 to 60 inclusively with a precision of 0.1. The default is 30. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose stream you want to create a clip from. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Request Clip Creation From VOD **Slug:** `TWITCH_CREATE_CLIP_FROM_VOD` Starts Twitch's asynchronous clip-creation process from a VOD. A 202 response is acceptance, not completed creation. Use GET_CLIPS with the returned ID to verify completion. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `title` | string | Yes | The title of the clip. | | `vod_id` | string | Yes | ID of the VOD the user wants to clip. | | `duration` | number | No | The length of the clip, in seconds. Precision is 0.1. Defaults to 30. Min: 5 seconds, Max: 60 seconds. | | `editor_id` | string | Yes | The user ID of the editor for the channel you want to create a clip for. If using the broadcaster’s auth token, this is the same as broadcaster_id. This must match the user_id in the user access token. | | `vod_offset` | integer | Yes | The zero-based offset where the clip ends. It must be at least duration and less than the VOD's duration. | | `broadcaster_id` | string | Yes | The user ID for the channel you want to create a clip for. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Custom Rewards **Slug:** `TWITCH_CREATE_CUSTOM_REWARDS` Creates a Custom Reward in the broadcaster’s channel. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cost` | integer | Yes | The cost of the reward, in Channel Points. The minimum is 1 point. | | `title` | string | Yes | The custom reward’s title. The title may contain a maximum of 45 characters and it must be unique amongst all of the broadcaster’s custom rewards. | | `prompt` | string | No | The prompt shown to the viewer when they redeem the reward. Specify a prompt if is_user_input_required is true . The prompt is limited to a maximum of 200 characters. | | `is_enabled` | boolean | No | A Boolean value that determines whether the reward is enabled. Viewers see only enabled rewards. The default is true . | | `broadcaster_id` | string | Yes | The ID of the broadcaster to add the custom reward to. This ID must match the user ID found in the OAuth token. | | `max_per_stream` | integer | No | The maximum number of redemptions allowed per live stream. Applied only if is_max_per_stream_enabled is true . The minimum value is 1. | | `background_color` | string | No | The background color to use for the reward. Specify the color using Hex format (for example, #9147FF). | | `is_user_input_required` | boolean | No | A Boolean value that determines whether the user needs to enter information when redeeming the reward. See the prompt field. The default is false . | | `global_cooldown_seconds` | integer | No | The cooldown period, in seconds. Applied only if the is_global_cooldown_enabled field is true . The minimum value is 1; however, the minimum value is 60 for it to be shown in the Twitch UX. | | `max_per_user_per_stream` | integer | No | The maximum number of redemptions allowed per user per stream. Applied only if is_max_per_user_per_stream_enabled is true . The minimum value is 1. | | `is_max_per_stream_enabled` | boolean | No | A Boolean value that determines whether to limit the maximum number of redemptions allowed per live stream (see the max_per_stream field). The default is false . | | `is_global_cooldown_enabled` | boolean | No | A Boolean value that determines whether to apply a cooldown period between redemptions (see the global_cooldown_seconds field for the duration of the cooldown period). The default is false . | | `is_max_per_user_per_stream_enabled` | boolean | No | A Boolean value that determines whether to limit the maximum number of redemptions allowed per user per stream (see the max_per_user_per_stream field). The default is false . | | `should_redemptions_skip_request_queue` | boolean | No | A Boolean value that determines whether redemptions should be set to FULFILLED status immediately when a reward is redeemed. If false , status is set to UNFULFILLED and follows the normal request queue process. The default is false . | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create EventSub Subscription **Slug:** `TWITCH_CREATE_EVENTSUB_SUBSCRIPTION` Creates one of the 78 supported EventSub type/version combinations over WebSocket using user OAuth. The selected type and version determine its documented conditional OAuth scope; the eight unscoped types require no scope. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("automod.message.hold" | "automod.message.update" | "automod.settings.update" | "automod.terms.update" | "channel.ad_break.begin" | "channel.ban" | "channel.bits.use" | "channel.channel_points_automatic_reward_redemption.add" | "channel.channel_points_custom_reward.add" | "channel.channel_points_custom_reward_redemption.add" | "channel.channel_points_custom_reward_redemption.update" | "channel.channel_points_custom_reward.remove" | "channel.channel_points_custom_reward.update" | "channel.charity_campaign.donate" | "channel.charity_campaign.progress" | "channel.charity_campaign.start" | "channel.charity_campaign.stop" | "channel.chat.clear" | "channel.chat.clear_user_messages" | "channel.chat.message" | "channel.chat.message_delete" | "channel.chat.notification" | "channel.chat.user_message_hold" | "channel.chat.user_message_update" | "channel.chat_settings.update" | "channel.cheer" | "channel.custom_power_up_redemption.add" | "channel.follow" | "channel.goal.begin" | "channel.goal.end" | "channel.goal.progress" | "channel.guest_star_guest.update" | "channel.guest_star_session.begin" | "channel.guest_star_session.end" | "channel.guest_star_settings.update" | "channel.hype_train.begin" | "channel.hype_train.end" | "channel.hype_train.progress" | "channel.moderate" | "channel.moderator.add" | "channel.moderator.remove" | "channel.poll.begin" | "channel.poll.end" | "channel.poll.progress" | "channel.prediction.begin" | "channel.prediction.end" | "channel.prediction.lock" | "channel.prediction.progress" | "channel.raid" | "channel.shared_chat.begin" | "channel.shared_chat.end" | "channel.shared_chat.update" | "channel.shield_mode.begin" | "channel.shield_mode.end" | "channel.shoutout.create" | "channel.shoutout.receive" | "channel.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.suspicious_user.message" | "channel.suspicious_user.update" | "channel.unban" | "channel.unban_request.create" | "channel.unban_request.resolve" | "channel.update" | "channel.vip.add" | "channel.vip.remove" | "channel.warning.acknowledge" | "channel.warning.send" | "stream.offline" | "stream.online" | "user.update" | "user.whisper.message") | Yes | EventSub type supported for WebSocket delivery with user OAuth. The selected type determines the conditional OAuth scope requirement published by this action. | | `version` | string | Yes | Exact supported version for the selected WebSocket/user-OAuth EventSub type. | | `condition` | object | Yes | Subscription-type-specific condition fields and values. | | `transport` | object | Yes | WebSocket notification transport associated with the user OAuth token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Guest Star Session **Slug:** `TWITCH_CREATE_GUEST_STAR_SESSION` BETA Programmatically creates a Guest Star session on behalf of the broadcaster. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `broadcaster_id` | string | Yes | The ID of the broadcaster you want to create a Guest Star session for. Provided broadcaster_id must match the user_id in the auth token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Poll **Slug:** `TWITCH_CREATE_POLL` Creates a poll that viewers in the broadcaster’s channel can vote on. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `title` | string | Yes | The question that viewers will vote on. For example, What game should I play next? The question may contain a maximum of 60 characters. | | `choices` | array | Yes | A list of choices that viewers may choose from. The list must contain a minimum of 2 choices and up to a maximum of 5 choices. | | `duration` | integer | Yes | The length of time (in seconds) that the poll will run for. The minimum is 15 seconds and the maximum is 1800 seconds (30 minutes). | | `broadcaster_id` | string | Yes | The ID of the broadcaster that’s running the poll. This ID must match the user ID in the user access token. | | `channel_points_per_vote` | integer | No | The number of points that the viewer must spend to cast one additional vote. The minimum is 1 and the maximum is 1000000. Set only if ChannelPointsVotingEnabled is true . | | `channel_points_voting_enabled` | boolean | No | A Boolean value that indicates whether viewers may cast additional votes using Channel Points. If true , the viewer may cast more than one vote but each additional vote costs the number of Channel Points specified in channel_points_per_vote . The default is false (viewers may cast only one vote). For information about Channel Points, see Channel Points Guide . | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Prediction **Slug:** `TWITCH_CREATE_PREDICTION` Create a Channel Points Prediction. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `title` | string | Yes | The question that the broadcaster is asking. For example, Will I finish this entire pizza? The title is limited to a maximum of 45 characters. | | `outcomes` | array | Yes | The list of possible outcomes that the viewers may choose from. The list must contain a minimum of 2 choices and up to a maximum of 10 choices. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that’s running the prediction. This ID must match the user ID in the user access token. | | `prediction_window` | integer | Yes | The length of time (in seconds) that the prediction will run for. The minimum is 30 seconds and the maximum is 1800 seconds (30 minutes). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Stream Marker **Slug:** `TWITCH_CREATE_STREAM_MARKER` Adds a marker to a live stream. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | ID of the broadcaster whose live stream to mark; must match the user ID in the access token. | | `description` | string | No | Optional marker description, up to 140 characters. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Channel Stream Schedule Segment **Slug:** `TWITCH_DELETE_CHANNEL_STREAM_SCHEDULE_SEGMENT` Deletes a broadcast from the broadcaster’s streaming schedule. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the broadcast segment to remove. | | `broadcaster_id` | string | Yes | ID of the broadcaster that owns the schedule. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Chat Messages **Slug:** `TWITCH_DELETE_CHAT_MESSAGES` Removes a single chat message or all chat messages from the broadcaster’s chat room. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `message_id` | string | No | The ID of the message to remove. The id tag in the PRIVMSG tag contains the message’s ID. Restrictions: The message must have been created within the last 6 hours. The message must not belong to the broadcaster. The message must not belong to another moderator. If not specified, the request removes all messages in the broadcaster’s chat room. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that owns the chat room to remove messages from. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Custom Reward **Slug:** `TWITCH_DELETE_CUSTOM_REWARD` Deletes a custom reward that the broadcaster created. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The ID of the custom reward to delete. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that created the custom reward. This ID must match the user ID found in the OAuth token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete EventSub Subscription **Slug:** `TWITCH_DELETE_EVENTSUB_SUBSCRIPTION` Deletes an EventSub subscription. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the EventSub subscription to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Guest Star Invite **Slug:** `TWITCH_DELETE_GUEST_STAR_INVITE` BETA Revokes a previously sent invite for a Guest Star session. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `guest_id` | string | Yes | Twitch User ID for the guest to revoke the Guest Star session invite from. | | `session_id` | string | Yes | The ID of the session for the invite to be revoked on behalf of the broadcaster. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user_id in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster running the Guest Star session. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Guest Star Slot **Slug:** `TWITCH_DELETE_GUEST_STAR_SLOT` BETA Allows a caller to remove a slot assignment from a user participating in an active Guest Star session. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `slot_id` | string | Yes | The slot ID representing the slot assignment to remove from the session. | | `guest_id` | string | Yes | The Twitch User ID corresponding to the guest to remove from the session. | | `session_id` | string | Yes | The ID of the Guest Star session in which to remove the slot assignment. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster running the Guest Star session. | | `should_reinvite_guest` | boolean | No | Flag signaling that the guest should be reinvited to the session, sending them back to the invite queue. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Videos **Slug:** `TWITCH_DELETE_VIDEOS` Deletes one or more videos. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | array | Yes | Video IDs to delete; Twitch accepts up to five repeated id parameters. Invalid video IDs are ignored. If the user lacks permission to delete any video in the list, none of the videos are deleted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### End Guest Star Session **Slug:** `TWITCH_END_GUEST_STAR_SESSION` BETA Programmatically ends a Guest Star session on behalf of the broadcaster. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `session_id` | string | Yes | ID for the session to end on behalf of the broadcaster. | | `broadcaster_id` | string | Yes | The ID of the broadcaster you want to end a Guest Star session for. Provided broadcaster_id must match the user_id in the auth token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### End Poll **Slug:** `TWITCH_END_POLL` End an active poll. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The ID of the poll to update. | | `status` | string ("TERMINATED" | "ARCHIVED") | Yes | The status to set the poll to. Possible case-sensitive values are: TERMINATED — Ends the poll before the poll is scheduled to end. The poll remains publicly visible. ARCHIVED — Ends the poll before the poll is scheduled to end, and then archives it so it's no longer publicly visible. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that’s running the poll. This ID must match the user ID in the user access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### End Prediction **Slug:** `TWITCH_END_PREDICTION` Locks, resolves, or cancels a Channel Points Prediction. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The ID of the prediction to update. | | `status` | string ("RESOLVED" | "CANCELED" | "LOCKED") | Yes | The status to set the prediction to. Possible case-sensitive values are: RESOLVED — The winning outcome is determined and the Channel Points are distributed to the viewers who predicted the correct outcome. CANCELED — The broadcaster is canceling the prediction and sending refunds to the participants. LOCKED — The broadcaster is locking the prediction, which means viewers may no longer make predictions. The broadcaster can update an active prediction to LOCKED, RESOLVED, or CANCELED; and update a locked prediction to RESOLVED or CANCELED. The broadcaster has up to 24 hours after the prediction window closes to resolve the prediction. If not, Twitch sets the status to CANCELED and returns the points. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that’s running the prediction. This ID must match the user ID in the user access token. | | `winning_outcome_id` | string | No | The ID of the winning outcome. You must set this parameter if you set status to RESOLVED. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ad Schedule **Slug:** `TWITCH_GET_AD_SCHEDULE` Returns the next ad's scheduled time and duration, available snooze count and refresh time, prior ad time, and remaining pre-roll-free time. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `broadcaster_id` | string | Yes | Provided broadcaster_id must match the user_id in the auth token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All Stream Tags **Slug:** `TWITCH_GET_ALL_STREAM_TAGS` Deprecated: this endpoint was retired and returns HTTP 410 Gone. Use GET_CHANNEL_INFORMATION and its tags field instead. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | Continuation cursor returned by a previous call. | | `first` | integer | No | Maximum tags to return. | | `tag_id` | array | No | Specific stream tag IDs to retrieve, up to 100 IDs. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get AutoMod Settings **Slug:** `TWITCH_GET_AUTOMOD_SETTINGS` Gets the broadcaster’s AutoMod settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose AutoMod settings you want to get. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Banned Users **Slug:** `TWITCH_GET_BANNED_USERS` Gets one cursor page of users that the broadcaster banned or put in a timeout. Follow the returned cursor to retrieve the full collection. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | Provider cursor for an initial forward page request. | | `first` | integer | No | The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per page. The default is 20. | | `before` | string | No | Provider cursor for an initial backward page request. | | `cursor` | string | No | Opaque continuation cursor returned by this action. | | `user_id` | array | No | A list of user IDs used to filter the results. To specify more than one ID, include this parameter for each user you want to get. For example, user_id=1234&user_id=5678 . You may specify a maximum of 100 IDs. The returned list includes only those users that were banned or put in a timeout. The list is returned in the same order that you specified the IDs. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose list of banned users you want to get. This ID must match the user ID in the access token. | | `pagination_direction` | string ("forward" | "backward") | No | Continuation direction. Set automatically from before and preserved in opaque cursors. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Bits Leaderboard **Slug:** `TWITCH_GET_BITS_LEADERBOARD` Gets the Bits leaderboard for the authenticated broadcaster. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `count` | integer | No | The number of results to return. The minimum count is 1 and the maximum is 100. The default is 10. | | `period` | string ("day" | "week" | "month" | "year" | "all") | No | The time period over which data is aggregated (uses the PST time zone). Possible values are: day — A day spans from 00:00:00 on the day specified in started_at and runs through 00:00:00 of the next day. week — A week spans from 00:00:00 on the Monday of the week specified in started_at and runs through 00:00:00 of the next Monday. month — A month spans from 00:00:00 on the first day of the month specified in started_at and runs through 00:00:00 of the first day of the next month. year — A year spans from 00:00:00 on the first day of the year specified in started_at and runs through 00:00:00 of the first day of the next year. all — Default. The lifetime of the broadcaster's channel. | | `user_id` | string | No | An ID that identifies a user that cheered bits in the channel. If count is greater than 1, the response may include users ranked above and below the specified user. To get the leaderboard’s top leaders, don’t specify a user ID. | | `started_at` | string | No | The start date, in RFC3339 format, used for determining the aggregation period. Specify this parameter only if you specify the period query parameter. The start date is ignored if period is all. Note that the date is converted to PST before being used, so if you set the start time to 2022-01-01T00:00:00.0Z and period to month, the actual reporting period is December 2021, not January 2022. If you want the reporting period to be January 2022, you must set the start time to 2022-01-01T08:00:00.0Z or 2022-01-01T00:00:00.0-08:00 . If your start date uses the ‘+’ offset operator (for example, 2022-01-01T00:00:00.0+05:00 ), you must URL encode the start date. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Blocked Terms **Slug:** `TWITCH_GET_BLOCKED_TERMS` Gets the broadcaster’s list of non-private, blocked words or phrases. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. | | `first` | integer | No | The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per page. The default is 20. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose blocked terms you’re getting. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Broadcaster Subscriptions **Slug:** `TWITCH_GET_BROADCASTER_SUBSCRIPTIONS` Gets a list of users that subscribe to the specified broadcaster. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | Provider cursor for an initial forward page request. | | `first` | integer | No | Maximum subscriptions to return (1-100). | | `before` | string | No | Provider cursor for an initial backward page request. | | `cursor` | string | No | Opaque continuation cursor returned by this action. | | `user_id` | array | No | Subscriber user IDs to filter by, up to 100 subscribers. | | `broadcaster_id` | string | Yes | ID of the broadcaster whose subscriptions to retrieve. | | `pagination_direction` | string ("forward" | "backward") | No | Continuation direction. Set automatically from before and preserved in opaque cursors. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Channel Chat Badges **Slug:** `TWITCH_GET_CHANNEL_CHAT_BADGES` Gets the broadcaster’s list of custom chat badges. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `broadcaster_id` | string | Yes | The ID of the broadcaster whose chat badges you want to get. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Channel Editors **Slug:** `TWITCH_GET_CHANNEL_EDITORS` Gets the broadcaster’s list editors. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `broadcaster_id` | string | Yes | The ID of the broadcaster that owns the channel. This ID must match the user ID in the access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Channel Emotes **Slug:** `TWITCH_GET_CHANNEL_EMOTES` Gets the broadcaster’s list of custom emotes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `broadcaster_id` | string | Yes | An ID that identifies the broadcaster whose emotes you want to get. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Channel Followers **Slug:** `TWITCH_GET_CHANNEL_FOLLOWERS` Gets a list of users that follow the specified broadcaster. You can also use this endpoint to see whether a specific user follows the broadcaster. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read more . | | `first` | integer | No | The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100. The default is 20. | | `user_id` | string | No | A user’s ID. Use this parameter to see whether the user follows this broadcaster. If specified, the response contains this user if they follow the broadcaster. If not specified, the response contains all users that follow the broadcaster. Using this parameter requires both a user access token with the moderator:read:followers scope and the user ID in the access token match the broadcaster_id or be the user ID for a moderator of the specified broadcaster. | | `broadcaster_id` | string | Yes | The broadcaster’s ID. Returns the list of users that follow this broadcaster. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Channel Guest Star Settings **Slug:** `TWITCH_GET_CHANNEL_GUEST_STAR_SETTINGS` BETA Gets the channel settings for configuration of the Guest Star feature for a particular host. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster you want to get guest star settings for. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Channel iCalendar **Slug:** `TWITCH_GET_CHANNEL_ICALENDAR` Gets the broadcaster’s streaming schedule as an iCalendar . #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `broadcaster_id` | string | Yes | ID of the broadcaster whose schedule to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Channel Information **Slug:** `TWITCH_GET_CHANNEL_INFORMATION` Gets information about one or more channels. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `broadcaster_id` | array | Yes | The ID of the broadcaster whose channel you want to get. To specify more than one ID, include this parameter for each broadcaster you want to get. For example, broadcaster_id=1234&broadcaster_id=5678 . You may specify a maximum of 100 IDs. The API ignores duplicate IDs and IDs that are not found. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Channel Stream Schedule **Slug:** `TWITCH_GET_CHANNEL_STREAM_SCHEDULE` Gets the broadcaster’s streaming schedule. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | array | No | Scheduled segment IDs to retrieve; include id once per segment, up to 100 IDs. | | `after` | string | No | Continuation cursor returned by a previous call. | | `first` | integer | No | Maximum segments to return. | | `start_time` | string | No | RFC3339 start time used to filter the schedule. | | `utc_offset` | integer | No | Compatibility input retained as an integer GMT offset in minutes and sent to Twitch. Twitch documents utc_offset as unsupported, so it is not promised to change the returned schedule. | | `broadcaster_id` | string | Yes | ID of the broadcaster whose schedule to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Channel Teams **Slug:** `TWITCH_GET_CHANNEL_TEAMS` Gets the list of Twitch teams that the broadcaster is a member of. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `broadcaster_id` | string | Yes | ID of the broadcaster whose teams to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Charity Campaign **Slug:** `TWITCH_GET_CHARITY_CAMPAIGN` Gets information about the broadcaster’s active charity campaign. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `broadcaster_id` | string | Yes | The ID of the broadcaster that’s currently running a charity campaign. This ID must match the user ID in the access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Charity Campaign Donations **Slug:** `TWITCH_GET_CHARITY_CAMPAIGN_DONATIONS` Gets the list of donations that users have made to the broadcaster’s active charity campaign. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read More | | `first` | integer | No | The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100. The default is 20. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that’s currently running a charity campaign. This ID must match the user ID in the access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Chat Settings **Slug:** `TWITCH_GET_CHAT_SETTINGS` Gets the broadcaster’s chat settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `moderator_id` | string | No | The ID of the broadcaster or one of the broadcaster’s moderators. This field is required only if you want to include the non_moderator_chat_delay and non_moderator_chat_delay_duration settings in the response. If you specify this field, this ID must match the user ID in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose chat settings you want to get. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Chatters **Slug:** `TWITCH_GET_CHATTERS` Gets the list of users that are connected to the broadcaster’s chat session. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read More | | `first` | integer | No | The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 1,000. The default is 100. | | `moderator_id` | string | Yes | The ID of the broadcaster or one of the broadcaster’s moderators. This ID must match the user ID in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose list of chatters you want to get. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Cheermotes **Slug:** `TWITCH_GET_CHEERMOTES` Gets a list of Cheermotes that users can use to cheer Bits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `broadcaster_id` | string | No | The ID of the broadcaster whose custom Cheermotes you want to get. Specify the broadcaster’s ID if you want to include the broadcaster’s Cheermotes in the response (not all broadcasters upload Cheermotes). If not specified, the response contains only global Cheermotes. If the broadcaster uploaded Cheermotes, the type field in the response is set to channel_custom . | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Clips **Slug:** `TWITCH_GET_CLIPS` Gets clips selected by exactly one broadcaster ID, game ID, or list of clip IDs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | array | No | An ID that identifies the clip to get. To specify more than one ID, include this parameter for each clip you want to get. For example, id=foo&id=bar . You may specify a maximum of 100 IDs. The API ignores duplicate IDs and IDs that aren’t found. | | `after` | string | No | Provider cursor for an initial forward page request. | | `first` | integer | No | The maximum number of clips to return per page in the response. The minimum page size is 1 clip per page and the maximum is 100. The default is 20. | | `before` | string | No | Provider cursor for an initial backward page request. | | `cursor` | string | No | Opaque continuation cursor returned by this action. | | `game_id` | string | No | An ID that identifies the game whose clips you want to get. Use this parameter to get clips that were captured from streams that were playing this game. | | `ended_at` | string | No | The end date used to filter clips. If not specified, the time window is the start date plus one week. Specify the date and time in RFC3339 format. | | `started_at` | string | No | The start date used to filter clips. The API returns only clips within the start and end date window. Specify the date and time in RFC3339 format. | | `is_featured` | boolean | No | A Boolean value that determines whether the response includes featured clips. If true , returns only clips that are featured. If false , returns only clips that aren’t featured. All clips are returned if this parameter is not present. | | `broadcaster_id` | string | No | An ID that identifies the broadcaster whose video clips you want to get. Use this parameter to get clips that were captured from the broadcaster’s streams. | | `pagination_direction` | string ("forward" | "backward") | No | Continuation direction. Set automatically from before and preserved in opaque cursors. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Clips Download **Slug:** `TWITCH_GET_CLIPS_DOWNLOAD` Provides URLs to download the video file(s) for the specified clips. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `clip_id` | array | Yes | The ID that identifies the clip you want to download. Include this parameter for each clip you want to download, up to a maximum of 10 clips. For example, clip_id=SleepyGiftedPeppermintNerfRedBlaster-KbkBXYt3lOk3jy8-&clip_id=WimpyAltruisticKleeKeyboardCat-EiY5yMrEwZ4i4gwC . | | `editor_id` | string | Yes | The User ID of the editor for the channel you want to download a clip for. If using the broadcaster’s auth token, this is the same as broadcaster_id . This must match the user_id in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster you want to download clips for. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Content Classification Labels **Slug:** `TWITCH_GET_CONTENT_CLASSIFICATION_LABELS` Gets information about Twitch content classification labels. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `locale` | string | No | BCP-47 locale for localized label descriptions. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Creator Goals **Slug:** `TWITCH_GET_CREATOR_GOALS` Gets the broadcaster’s list of active goals. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `broadcaster_id` | string | Yes | The ID of the broadcaster that created the goals. This ID must match the user ID in the user access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Custom Power-up **Slug:** `TWITCH_GET_CUSTOM_POWER_UP` Gets a list of custom Power-ups that the specified broadcaster created. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | array | No | A list of IDs to filter the Power-ups by. To specify more than one ID, include this parameter for each Power-up you want to get. For example, id=1234&id=5678 . You may specify a maximum of 50 IDs. Duplicate IDs are ignored. The response contains only the IDs that were found. If none of the IDs were found, the response is 404 Not Found. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose custom Power-ups you want to get. This ID must match the user ID found in the OAuth token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Custom Reward **Slug:** `TWITCH_GET_CUSTOM_REWARD` Gets a list of custom rewards that the specified broadcaster created. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | array | No | A list of IDs to filter the rewards by. To specify more than one ID, include this parameter for each reward you want to get. For example, id=1234&id=5678 . You may specify a maximum of 50 IDs. Duplicate IDs are ignored. The response contains only the IDs that were found. If none of the IDs were found, the response is 404 Not Found. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose custom rewards you want to get. This ID must match the user ID found in the OAuth token. | | `only_manageable_rewards` | boolean | No | A Boolean value that determines whether the response contains only the custom rewards that the app may manage (the app is identified by the ID in the Client-Id header). Set to true to get only the custom rewards that the app may manage. The default is false . | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Custom Reward Redemption **Slug:** `TWITCH_GET_CUSTOM_REWARD_REDEMPTION` Gets a list of redemptions for a custom reward. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | array | No | A list of IDs to filter the redemptions by. To specify more than one ID, include this parameter for each redemption you want to get. For example, id=1234&id=5678 . You may specify a maximum of 50 IDs. Duplicate IDs are ignored. The response contains only the IDs that were found. If none of the IDs were found, the response is 404 Not Found. | | `sort` | string ("OLDEST" | "NEWEST") | No | The order to sort redemptions by. The possible case-sensitive values are: OLDEST NEWEST The default is OLDEST. | | `after` | string | No | The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read more | | `first` | integer | No | The maximum number of redemptions to return per page in the response. The minimum page size is 1 redemption per page and the maximum is 50. The default is 20. | | `status` | string ("CANCELED" | "FULFILLED" | "UNFULFILLED") | No | The status of the redemptions to return. The possible case-sensitive values are: CANCELED FULFILLED UNFULFILLED NOTE : This field is required only if you don’t specify the id query parameter. NOTE : Canceled and fulfilled redemptions are returned for only a few days after they’re canceled or fulfilled. | | `reward_id` | string | Yes | The ID that identifies the custom reward whose redemptions you want to get. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that owns the custom reward. This ID must match the user ID found in the user OAuth token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Drops Entitlements **Slug:** `TWITCH_GET_DROPS_ENTITLEMENTS` Gets Drops entitlements granted to the user in the OAuth token, optionally filtered by entitlement ID, game, or fulfillment status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | array | No | Entitlement IDs to retrieve; include id once per entitlement, up to 100 IDs. | | `after` | string | No | Continuation cursor returned by a previous call. | | `first` | integer | No | Maximum entitlements on this page (1-1000). | | `game_id` | string | No | Game ID filter; results remain limited to the user in the OAuth token. | | `fulfillment_status` | string ("CLAIMED" | "FULFILLED") | No | Filter by CLAIMED or FULFILLED status. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Emote Sets **Slug:** `TWITCH_GET_EMOTE_SETS` Gets emotes for one or more specified emote sets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `emote_set_id` | array | Yes | An ID that identifies the emote set to get. Include this parameter for each emote set you want to get. For example, emote_set_id=1234&emote_set_id=5678 . You may specify a maximum of 25 IDs. The response contains only the IDs that were found and ignores duplicate IDs. To get emote set IDs, use the Get Channel Emotes API. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get EventSub Subscriptions **Slug:** `TWITCH_GET_EVENTSUB_SUBSCRIPTIONS` Lists WebSocket EventSub subscriptions associated with the connected user OAuth token. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string | No | Filter by subscription type. | | `after` | string | No | Continuation cursor returned by a previous call. | | `status` | string ("enabled" | "authorization_revoked" | "moderator_removed" | "user_removed" | "chat_user_banned" | "version_removed" | "beta_maintenance" | "websocket_disconnected" | "websocket_failed_ping_pong" | "websocket_received_inbound_traffic" | "websocket_connection_unused" | "websocket_internal_error" | "websocket_network_timeout" | "websocket_network_error" | "websocket_failed_to_reconnect") | No | Filter by subscription status. | | `user_id` | string | No | Filter by user ID present in the condition. | | `subscription_id` | string | No | Filter by one subscription ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Extension Analytics **Slug:** `TWITCH_GET_EXTENSION_ANALYTICS` Gets an analytics report for one or more extensions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string | No | The type of analytics report to get. Possible values are: overview_v2 | | `after` | string | No | The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read More This parameter is ignored if the extension_id parameter is set. | | `first` | integer | No | The maximum number of report URLs to return per page in the response. The minimum page size is 1 URL per page and the maximum is 100 URLs per page. The default is 20. NOTE : While you may specify a maximum value of 100, the response will contain at most 20 URLs per page. | | `ended_at` | string | No | The reporting window's end date, in RFC3339 format. Set the time portion to zeroes (for example, 2021-10-27T00:00:00Z). The report is inclusive of the end date. Specify an end date only if you provide a start date. Because it can take up to two days for the data to be available, you must specify an end date that's earlier than today minus one to two days. If not, the API ignores your end date and uses an end date that is today minus one to two days. | | `started_at` | string | No | The reporting window's start date, in RFC3339 format. Set the time portion to zeroes (for example, 2021-10-22T00:00:00Z). The start date must be on or after January 31, 2018. If you specify an earlier date, the API ignores it and uses January 31, 2018. If you specify a start date, you must specify an end date. If you don't specify a start and end date, the report includes all available data since January 31, 2018. The report contains one row of data for each day in the reporting window. | | `extension_id` | string | No | The extension's client ID. If specified, the response contains a report for the specified extension. If not specified, the response includes a report for each extension that the authenticated user owns. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Extension Live Channels **Slug:** `TWITCH_GET_EXTENSION_LIVE_CHANNELS` Gets a list of broadcasters that are streaming live and have installed or activated the extension. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | Continuation cursor returned by a previous call. | | `first` | integer | No | Maximum live channels on this page (1-100). | | `extension_id` | string | Yes | Extension Client ID whose live channels to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Followed Channels **Slug:** `TWITCH_GET_FOLLOWED_CHANNELS` Gets a list of broadcasters that the specified user follows. You can also use this endpoint to see whether a user follows a specific broadcaster. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read more . | | `first` | integer | No | The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100. The default is 20. | | `user_id` | string | Yes | A user’s ID. Returns the list of broadcasters that this user follows. This ID must match the user ID in the user OAuth token. | | `broadcaster_id` | string | No | A broadcaster’s ID. Use this parameter to see whether the user follows this broadcaster. If specified, the response contains this broadcaster if the user follows them. If not specified, the response contains all broadcasters that the user follows. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Followed Streams **Slug:** `TWITCH_GET_FOLLOWED_STREAMS` Gets the list of broadcasters that the user follows and that are streaming live. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | Continuation cursor returned by a previous call. | | `first` | integer | No | Maximum streams to return. | | `user_id` | string | Yes | ID of the authenticated user whose followed live streams to retrieve; must match the user ID in the access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Game Analytics **Slug:** `TWITCH_GET_GAME_ANALYTICS` Gets an analytics report for one or more games. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string | No | The type of analytics report to get. Possible values are: overview_v2 | | `after` | string | No | The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read More This parameter is ignored if game_id parameter is set. | | `first` | integer | No | The maximum number of report URLs to return per page in the response. The minimum page size is 1 URL per page and the maximum is 100 URLs per page. The default is 20. NOTE : While you may specify a maximum value of 100, the response will contain at most 20 URLs per page. | | `game_id` | string | No | The game’s client ID. If specified, the response contains a report for the specified game. If not specified, the response includes a report for each of the authenticated user’s games. | | `ended_at` | string | No | The reporting window’s end date, in RFC3339 format. Set the time portion to zeroes (for example, 2021-10-22T00:00:00Z). The report is inclusive of the end date. Specify an end date only if you provide a start date. Because it can take up to two days for the data to be available, you must specify an end date that’s earlier than today minus one to two days. If not, the API ignores your end date and uses an end date that is today minus one to two days. | | `started_at` | string | No | The reporting window’s start date, in RFC3339 format. Set the time portion to zeroes (for example, 2021-10-22T00:00:00Z). If you specify a start date, you must specify an end date. The start date must be within one year of today’s date. If you specify an earlier date, the API ignores it and uses a date that’s one year prior to today’s date. If you don’t specify a start and end date, the report includes all available data for the last 365 days from today. The report contains one row of data for each day in the reporting window. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Games **Slug:** `TWITCH_GET_GAMES` Gets information about specified games. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | array | No | The ID of the category or game to get. Include this parameter for each category or game you want to get. For example, &id=1234&id=5678 . You may specify a maximum of 100 IDs. The endpoint ignores duplicate and invalid IDs or IDs that weren’t found. | | `name` | array | No | The name of the category or game to get. The name must exactly match the category’s or game’s title. Include this parameter for each category or game you want to get. For example, &name=foo&name=bar . You may specify a maximum of 100 names. The endpoint ignores duplicate names and names that weren’t found. | | `igdb_id` | array | No | The IGDB ID of the game to get. Include this parameter for each game you want to get. For example, &igdb_id=1234&igdb_id=5678 . You may specify a maximum of 100 IDs. The endpoint ignores duplicate and invalid IDs or IDs that weren’t found. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Global Chat Badges **Slug:** `TWITCH_GET_GLOBAL_CHAT_BADGES` Gets Twitch’s list of chat badges. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Global Emotes **Slug:** `TWITCH_GET_GLOBAL_EMOTES` Gets all global emotes. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Guest Star Invites **Slug:** `TWITCH_GET_GUEST_STAR_INVITES` BETA Provides the caller with a list of pending invites to a Guest Star session. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `session_id` | string | Yes | The session ID to query for invite status. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user_id in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster running the Guest Star session. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Guest Star Session **Slug:** `TWITCH_GET_GUEST_STAR_SESSION` BETA Gets information about an ongoing Guest Star session for a particular channel. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the user access token. | | `broadcaster_id` | string | Yes | ID for the user hosting the Guest Star session. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Hype Train Status **Slug:** `TWITCH_GET_HYPE_TRAIN_STATUS` Gets the status of a Hype Train for the specified broadcaster. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `broadcaster_id` | string | Yes | The User ID of the channel broadcaster. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Moderated Channels **Slug:** `TWITCH_GET_MODERATED_CHANNELS` Gets a list of channels that the specified user has moderator privileges in. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. | | `first` | integer | No | The maximum number of items to return per page in the response. Minimum page size is 1 item per page and the maximum is 100. The default is 20. | | `user_id` | string | Yes | A user’s ID. Returns the list of channels that this user has moderator privileges in. This ID must match the user ID in the user OAuth token | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Moderators **Slug:** `TWITCH_GET_MODERATORS` Gets all users allowed to moderate the broadcaster’s chat room. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read More | | `first` | integer | No | The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per page. The default is 20. | | `user_id` | array | No | A list of user IDs used to filter the results. To specify more than one ID, include this parameter for each moderator you want to get. For example, user_id=1234&user_id=5678 . You may specify a maximum of 100 IDs. The returned list includes only the users from the list who are moderators in the broadcaster’s channel. The list is returned in the same order as you specified the IDs. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose list of moderators you want to get. This ID must match the user ID in the access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Pinned Chat Message **Slug:** `TWITCH_GET_PINNED_CHAT_MESSAGE` Gets the currently pinned message for the broadcaster’s chat room. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that owns the chat room. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Polls **Slug:** `TWITCH_GET_POLLS` Gets a list of polls that the broadcaster created. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | array | No | A list of IDs that identify the polls to return. To specify more than one ID, include this parameter for each poll you want to get. For example, id=1234&id=5678 . You may specify a maximum of 20 IDs. Specify this parameter only if you want to filter the list that the request returns. The endpoint ignores duplicate IDs and those not owned by this broadcaster. | | `after` | string | No | The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read More | | `first` | integer | No | The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 20 items per page. The default is 20. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that created the polls. This ID must match the user ID in the user access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Predictions **Slug:** `TWITCH_GET_PREDICTIONS` Gets a list of Channel Points Predictions that the broadcaster created. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | array | No | The ID of the prediction to get. To specify more than one ID, include this parameter for each prediction you want to get. For example, id=1234&id=5678 . You may specify a maximum of 25 IDs. The endpoint ignores duplicate IDs and those not owned by the broadcaster. | | `after` | string | No | The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read More | | `first` | integer | No | The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 25 items per page. The default is 20. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose predictions you want to get. This ID must match the user ID in the user access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Released Extensions **Slug:** `TWITCH_GET_RELEASED_EXTENSIONS` Gets information about a released extension. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `extension_id` | string | Yes | Released Extension Client ID to retrieve. | | `extension_version` | string | No | Specific released version; omit for the latest released version. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Shared Chat Session **Slug:** `TWITCH_GET_SHARED_CHAT_SESSION` Retrieves the active shared chat session for a channel. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `broadcaster_id` | string | Yes | The User ID of the channel broadcaster. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Shield Mode Status **Slug:** `TWITCH_GET_SHIELD_MODE_STATUS` Gets the broadcaster’s Shield Mode activation status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `moderator_id` | string | Yes | The ID of the broadcaster or a user that is one of the broadcaster’s moderators. This ID must match the user ID in the access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose Shield Mode activation status you want to get. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Sensitive Stream Key **Slug:** `TWITCH_GET_STREAM_KEY` SENSITIVE: retrieves the channel's raw stream key, which grants the ability to broadcast as the channel. Use only when explicitly required; never log, quote, persist, or disclose the output. This is non-mutating and therefore uses the strongest available read-only ability hint. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `broadcaster_id` | string | Yes | ID of the broadcaster whose stream key to retrieve; must match the token user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Stream Markers **Slug:** `TWITCH_GET_STREAM_MARKERS` Gets markers from either a user's most recent stream or one specified VOD; provide exactly one selector. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | Provider cursor for an initial forward page request. | | `first` | integer | No | Maximum videos to return per page. | | `before` | string | No | Provider cursor for an initial backward page request. | | `cursor` | string | No | Opaque continuation cursor returned by this action. | | `user_id` | string | No | Broadcaster user ID whose stream markers to retrieve. | | `video_id` | string | No | Video ID whose stream markers to retrieve. | | `pagination_direction` | string ("forward" | "backward") | No | Continuation direction. Set automatically from before and preserved in opaque cursors. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Streams **Slug:** `TWITCH_GET_STREAMS` Gets a list of all streams. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("all" | "live") | No | Stream type filter; currently use all or live. | | `after` | string | No | Provider cursor for an initial forward page request. | | `first` | integer | No | Maximum streams to return. | | `before` | string | No | Provider cursor for an initial backward page request. | | `cursor` | string | No | Opaque continuation cursor returned by this action. | | `game_id` | array | No | Game or category IDs used to filter streams. | | `user_id` | array | No | User IDs used to filter streams. | | `language` | array | No | ISO 639-1 stream language filters; use other for streams without a supported language code. | | `user_login` | array | No | User login names used to filter streams. | | `pagination_direction` | string ("forward" | "backward") | No | Continuation direction. Set automatically from before and preserved in opaque cursors. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Stream Tags **Slug:** `TWITCH_GET_STREAM_TAGS` Deprecated: this endpoint was retired and returns HTTP 410 Gone. Use GET_CHANNEL_INFORMATION and its tags field instead. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `broadcaster_id` | string | Yes | ID of the broadcaster whose stream tags to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Teams **Slug:** `TWITCH_GET_TEAMS` Gets one Twitch team by exactly one team name or team ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | No | Team ID to retrieve. | | `name` | string | No | Team name to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Top Games **Slug:** `TWITCH_GET_TOP_GAMES` Gets games and categories ranked by current viewer count on Twitch. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | Provider cursor for an initial forward page request. | | `first` | integer | No | The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per page. The default is 20. | | `before` | string | No | Provider cursor for an initial backward page request. | | `cursor` | string | No | Opaque continuation cursor returned by this action. | | `pagination_direction` | string ("forward" | "backward") | No | Continuation direction. Set automatically from before and preserved in opaque cursors. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Unban Requests **Slug:** `TWITCH_GET_UNBAN_REQUESTS` Gets a list of unban requests for a broadcaster’s channel. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | Cursor used to get next page of results. Pagination object in response contains cursor value. | | `first` | integer | No | The maximum number of items to return per page in response | | `status` | string ("pending" | "approved" | "denied" | "acknowledged" | "canceled") | Yes | Filter by a status. pending approved denied acknowledged canceled | | `user_id` | string | No | The ID used to filter what unban requests are returned. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s unban requests. This ID must match the user ID in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose channel is receiving unban requests. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User Active Extensions **Slug:** `TWITCH_GET_USER_ACTIVE_EXTENSIONS` Gets the active extensions that the broadcaster has installed for each configuration. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | No | Broadcaster ID. Omit it to use the broadcaster represented by the connected user access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User Block List **Slug:** `TWITCH_GET_USER_BLOCK_LIST` Gets the list of users that the broadcaster has blocked. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | Continuation cursor returned by a previous call. | | `first` | integer | No | Maximum blocked users to return. | | `broadcaster_id` | string | Yes | ID of the authenticated user whose block list to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User Chat Color **Slug:** `TWITCH_GET_USER_CHAT_COLOR` Gets the color used for the user’s name in chat. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | array | Yes | The ID of the user whose username color you want to get. To specify more than one user, include the user_id parameter for each user to get. For example, &user_id=1234&user_id=5678 . The maximum number of IDs that you may specify is 100. The API ignores duplicate IDs and IDs that weren’t found. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User Emotes **Slug:** `TWITCH_GET_USER_EMOTES` Retrieves emotes available to the user across all channels. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. | | `user_id` | string | Yes | The ID of the user. This ID must match the user ID in the user access token. | | `broadcaster_id` | string | No | The User ID of a broadcaster you wish to get follower emotes of. Using this query parameter will guarantee inclusion of the broadcaster’s follower emotes in the response body. Note: If the user specified in user_id is subscribed to the broadcaster specified, their follower emotes will appear in the response body regardless if this query parameter is used. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User Extensions **Slug:** `TWITCH_GET_USER_EXTENSIONS` Gets a list of all extensions (both active and inactive) that the broadcaster has installed. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Users **Slug:** `TWITCH_GET_USERS` Gets information about one or more users. With no id or login selectors, returns the user represented by the access token. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | array | No | User IDs to retrieve. | | `login` | array | No | User login names to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Videos **Slug:** `TWITCH_GET_VIDEOS` Gets published videos selected by exactly one list of video IDs, broadcaster ID, or game ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | array | No | Video ID filter; mutually exclusive with user_id and game_id. | | `sort` | string ("time" | "trending" | "views") | No | Sort order for user_id or game_id: time, trending, or views. | | `type` | string ("all" | "archive" | "highlight" | "upload") | No | Video type filter for user_id or game_id: all, archive, highlight, or upload. | | `after` | string | No | Provider cursor for an initial forward page request. | | `first` | integer | No | Maximum videos per page; applies only with user_id or game_id. | | `before` | string | No | Provider cursor for an initial backward page request. | | `cursor` | string | No | Opaque continuation cursor returned by this action. | | `period` | string ("all" | "day" | "month" | "week") | No | Published-period filter for user_id or game_id: all, day, month, or week. | | `game_id` | string | No | Category ID filter; mutually exclusive with id and user_id. | | `user_id` | string | No | Broadcaster ID filter; mutually exclusive with id and game_id. | | `language` | string | No | ISO 639-1 broadcast language filter; applies only with user_id or game_id. | | `pagination_direction` | string ("forward" | "backward") | No | Continuation direction. Set automatically from before and preserved in opaque cursors. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get VIPs **Slug:** `TWITCH_GET_VIPS` Gets a list of the broadcaster’s VIPs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read More | | `first` | integer | No | The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100. The default is 20. | | `user_id` | array | No | Filters the list for specific VIPs. To specify more than one user, include the user_id parameter for each user to get. For example, &user_id=1234&user_id=5678 . The maximum number of IDs that you may specify is 100. Ignores the ID of those users in the list that aren’t VIPs. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose list of VIPs you want to get. This ID must match the user ID in the access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Allow or Deny Held AutoMod Message **Slug:** `TWITCH_MANAGE_HELD_AUTOMOD_MESSAGES` Allows or denies one message that AutoMod held for review. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `action` | string ("ALLOW" | "DENY") | Yes | The action to take for the message. Possible values are: ALLOW DENY | | `msg_id` | string | Yes | The ID of the message to allow or deny. | | `user_id` | string | Yes | The moderator who is approving or denying the held message. This ID must match the user ID in the access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Modify Channel Information **Slug:** `TWITCH_MODIFY_CHANNEL_INFORMATION` Updates a channel’s properties. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | A list of channel-defined tags to apply to the channel. To remove all tags from the channel, set tags to an empty array. Tags help identify the content that the channel streams. Learn More A channel may specify a maximum of 10 tags. Each tag is limited to a maximum of 25 characters and may not be an empty string or contain spaces or special characters. | | `delay` | integer | No | The number of seconds you want your broadcast buffered before streaming it live. The delay helps ensure fairness during competitive play. Only users with Partner status may set this field. The maximum delay is 900 seconds (15 minutes). | | `title` | string | No | The title of the user’s stream. You may not set this field to an empty string. | | `game_id` | string | No | The ID of the game that the user plays. The game is not updated if the ID isn’t a game ID that Twitch recognizes. To unset this field, use “0” or “” (an empty string). | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose channel you want to update. This ID must match the user ID in the user access token. | | `is_branded_content` | boolean | No | Boolean flag indicating if the channel has branded content. | | `broadcaster_language` | string | No | The user’s preferred language. Set the value to an ISO 639-1 two-letter language code (for example, en for English). Set to “other” if the user’s preferred language is not a Twitch supported language. The language isn’t updated if the language code isn’t a Twitch supported language. | | `content_classification_labels` | array | No | List of labels that should be set as the Channel’s CCLs. Note: To clear CCLs for a channel, set all is_enabled for all possible CCLs to false | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Pin Chat Message **Slug:** `TWITCH_PIN_CHAT_MESSAGE` Pins a chat message to the specified broadcaster’s chat room. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `message_id` | string | Yes | The ID of the message to pin. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that owns the chat room. | | `duration_seconds` | integer | No | The number of seconds the message should be pinned for. Minimum: 30. Maximum: 1800. If not specified, the message will be pinned until the stream ends. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Blocked Term **Slug:** `TWITCH_REMOVE_BLOCKED_TERM` Removes the word or phrase from the broadcaster’s list of blocked terms. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The ID of the blocked term to remove from the broadcaster’s list of blocked terms. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that owns the list of blocked terms. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Channel Moderator **Slug:** `TWITCH_REMOVE_CHANNEL_MODERATOR` Removes a moderator from the broadcaster’s chat room. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | The ID of the user to remove as a moderator from the broadcaster’s chat room. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that owns the chat room. This ID must match the user ID in the access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Channel VIP **Slug:** `TWITCH_REMOVE_CHANNEL_VIP` Removes the specified user as a VIP in the broadcaster’s channel. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | The ID of the user to remove VIP status from. | | `broadcaster_id` | string | Yes | The ID of the broadcaster who owns the channel where the user has VIP status. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Suspicious Status From Chat User **Slug:** `TWITCH_REMOVE_SUSPICIOUS_STATUS_FROM_CHAT_USER` Remove a suspicious user status from a chatter on broadcaster’s channel. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | The ID of the user having the suspicious status removed. | | `moderator_id` | string | Yes | The user ID of the moderator who is removing the status. | | `broadcaster_id` | string | Yes | The user ID of the broadcaster, indicating the channel where the status is being removed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Resolve Unban Requests **Slug:** `TWITCH_RESOLVE_UNBAN_REQUESTS` Resolves an unban request by approving or denying it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `status` | string ("approved" | "denied") | Yes | Resolution status. approved denied | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s unban requests. This ID must match the user ID in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose channel is approving or denying the unban request. | | `resolution_text` | string | No | Message supplied by the unban request resolver. The message is limited to a maximum of 500 characters. | | `unban_request_id` | string | Yes | The ID of the Unban Request to resolve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Categories **Slug:** `TWITCH_SEARCH_CATEGORIES` Gets the games or categories that match the specified query. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | Continuation cursor returned by a previous call. | | `first` | integer | No | Maximum categories to return. | | `query` | string | Yes | Raw search term for a category or game; the transport applies URI encoding. A category matches only when its name contains every part of the query, anywhere in the name, using a case-insensitive comparison. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Channels **Slug:** `TWITCH_SEARCH_CHANNELS` Gets the channels that match the specified query and have streamed content within the past 6 months. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `after` | string | No | Continuation cursor returned by a previous call. | | `first` | integer | No | Maximum channels to return. | | `query` | string | Yes | Raw, case-insensitive prefix search term for broadcaster channels; the transport applies URI encoding. | | `live_only` | boolean | No | When false or omitted, searches broadcaster login names and includes live and offline channels. When true, searches broadcaster names and category names and returns only channels currently streaming live. Matching is by case-insensitive prefix. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send a Shoutout **Slug:** `TWITCH_SEND_A_SHOUTOUT` Sends a Shoutout to the specified broadcaster. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `moderator_id` | string | Yes | The ID of the broadcaster or a user that is one of the broadcaster’s moderators. This ID must match the user ID in the access token. | | `to_broadcaster_id` | string | Yes | The ID of the broadcaster that’s receiving the Shoutout. | | `from_broadcaster_id` | string | Yes | The ID of the broadcaster that’s sending the Shoutout. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Chat Announcement **Slug:** `TWITCH_SEND_CHAT_ANNOUNCEMENT` Sends an announcement to the broadcaster’s chat room using user OAuth. In a Shared Chat session, the announcement is sent to all channels in the session, including the source channel. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `color` | string ("blue" | "green" | "orange" | "purple" | "primary") | No | The color used to highlight the announcement. Possible case-sensitive values are: blue green orange purple primary (default) If color is set to primary or is not set, the channel’s accent color is used to highlight the announcement (see Profile Accent Color under profile settings , Channel and Videos , and Brand ). | | `message` | string | Yes | The announcement to make in the broadcaster’s chat room. Announcements are limited to a maximum of 500 characters; announcements longer than 500 characters are truncated. | | `moderator_id` | string | Yes | The ID of a user who has permission to moderate the broadcaster’s chat room, or the broadcaster’s ID if they’re sending the announcement. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that owns the chat room to send the announcement to. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Chat Message **Slug:** `TWITCH_SEND_CHAT_MESSAGE` Sends a message to the broadcaster’s chat room using user OAuth and fails if Twitch reports that it was dropped. In a Shared Chat session, user OAuth sends the message to all channels in the session, including the source channel. Set reply_parent_message_id to reply or pin to send and immediately pin the message. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `pin` | boolean | No | If true, the message will be sent and immediately pinned. Default: false. Cannot be combined with reply_parent_message_id. When pin is true, additionally requires the moderator:manage:chat_messages scope and the sender must be the broadcaster or a moderator. Messages pinned via this endpoint are always pinned for 20 minutes. If the pin fails, the message is not sent. | | `message` | string | Yes | The message to send. The message is limited to a maximum of 500 characters. Chat messages can also include emoticons. To include emoticons, use the name of the emote. The names are case sensitive. Don’t include colons around the name (e.g., :bleedPurple:). If Twitch recognizes the name, Twitch converts the name to the emote before writing the chat message to the chat room | | `sender_id` | string | Yes | The ID of the user sending the message. This ID must match the user ID in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose chat room the message will be sent to. | | `reply_parent_message_id` | string | No | The ID of the chat message being replied to. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Guest Star Invite **Slug:** `TWITCH_SEND_GUEST_STAR_INVITE` BETA Sends an invite to a specified guest on behalf of the broadcaster for a Guest Star session in progress. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `guest_id` | string | Yes | Twitch User ID for the guest to invite to the Guest Star session. | | `session_id` | string | Yes | The session ID for the invite to be sent on behalf of the broadcaster. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user_id in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster running the Guest Star session. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Whisper **Slug:** `TWITCH_SEND_WHISPER` Requests delivery of a whisper message to the specified user. Twitch may silently drop a whisper while still returning HTTP 204, so a successful response does not confirm delivery. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `message` | string | Yes | Whisper message to send. The maximum is 500 characters if the recipient has not whispered the sender before, or 10,000 characters if the recipient has whispered the sender before. | | `to_user_id` | string | Yes | ID of the user receiving the whisper. | | `from_user_id` | string | Yes | ID of the verified user sending the whisper; must match the token user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Snooze Next Ad **Slug:** `TWITCH_SNOOZE_NEXT_AD` Pushes back the timestamp of the upcoming automatic mid-roll ad by 5 minutes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `broadcaster_id` | string | Yes | Provided broadcaster_id must match the user_id in the auth token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Start a raid **Slug:** `TWITCH_START_A_RAID` Initiates a pending raid of another channel. The raid occurs only when the broadcaster clicks Raid Now or the 90-second countdown expires; confirm completion separately through the Channel Raid event. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `to_broadcaster_id` | string | Yes | The ID of the broadcaster to raid. | | `from_broadcaster_id` | string | Yes | The ID of the broadcaster that’s sending the raiding party. This ID must match the user ID in the user access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Start Commercial **Slug:** `TWITCH_START_COMMERCIAL` Starts a commercial for a broadcaster that is a Twitch partner or affiliate and is currently streaming live. The broadcaster must invoke this action for itself, so broadcaster_id must match the user in the OAuth token. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `length` | integer | Yes | The length of the commercial to run, in seconds. Twitch tries to serve a commercial that’s the requested length, but it may be shorter or longer. The maximum length you should request is 180 seconds. | | `broadcaster_id` | string | Yes | The ID of the partner or affiliate broadcaster that wants to run the commercial. This ID must match the user ID found in the OAuth token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Unban User **Slug:** `TWITCH_UNBAN_USER` Removes the ban or timeout that was placed on the specified user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | The ID of the user to remove the ban or timeout from. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose chat room the user is banned from chatting in. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Unblock User **Slug:** `TWITCH_UNBLOCK_USER` Removes the user from the broadcaster’s list of blocked users. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `target_user_id` | string | Yes | ID of the user to remove from the authenticated user's block list; the request is a no-op if the user is not blocked. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Unpin Chat Message **Slug:** `TWITCH_UNPIN_CHAT_MESSAGE` Unpins a pinned chat message from the broadcaster’s chat room. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `message_id` | string | Yes | The ID of the message to unpin. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that owns the chat room. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update AutoMod Settings **Slug:** `TWITCH_UPDATE_AUTOMOD_SETTINGS` Updates the broadcaster’s AutoMod settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `bullying` | integer | No | The Automod level for hostility involving name calling or insults. | | `misogyny` | integer | No | The Automod level for discrimination against women. | | `swearing` | integer | No | The Automod level for profanity. | | `aggression` | integer | No | The AutoMod level for hostility involving aggression, from 0 through 4. | | `disability` | integer | No | The Automod level for discrimination against disability. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the user access token. | | `overall_level` | integer | No | The default AutoMod level for the broadcaster, from 0 through 4. Do not combine with individual levels. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose AutoMod settings you want to update. | | `sex_based_terms` | integer | No | The Automod level for sexual content. | | `sexuality_sex_or_gender` | integer | No | The AutoMod level for discrimination based on sexuality, sex, or gender. | | `race_ethnicity_or_religion` | integer | No | The Automod level for racial discrimination. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Channel Guest Star Settings **Slug:** `TWITCH_UPDATE_CHANNEL_GUEST_STAR_SETTINGS` BETA Updates Guest Star channel settings; regenerating browser sources immediately invalidates all previously configured browser sources. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `slot_count` | integer | No | Number of slots the Guest Star call interface will allow the host to add to a call. Required to be between 1 and 6. | | `group_layout` | string ("TILED_LAYOUT" | "SCREENSHARE_LAYOUT" | "HORIZONTAL_LAYOUT" | "VERTICAL_LAYOUT") | No | This setting determines how the guests within a session should be laid out within the browser source. Can be one of the following values: TILED_LAYOUT : All live guests are tiled within the browser source with the same size. SCREENSHARE_LAYOUT : All live guests are tiled within the browser source with the same size. If there is an active screen share, it is sized larger than the other guests. HORIZONTAL_LAYOUT : All live guests are arranged in a horizontal bar within the browser source VERTICAL_LAYOUT : All live guests are arranged in a vertical bar within the browser source | | `broadcaster_id` | string | Yes | The ID of the broadcaster you want to update Guest Star settings for. | | `regenerate_browser_sources` | boolean | No | Flag determining if Guest Star should regenerate the auth token associated with the channel’s browser sources. Providing a true value for this will immediately invalidate all browser sources previously configured in your streaming software. | | `is_moderator_send_live_enabled` | boolean | No | Flag determining if Guest Star moderators have access to control whether a guest is live once assigned to a slot. | | `is_browser_source_audio_enabled` | boolean | No | Flag determining if Browser Sources subscribed to sessions on this channel should output audio | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Channel Stream Schedule **Slug:** `TWITCH_UPDATE_CHANNEL_STREAM_SCHEDULE` Updates the broadcaster’s schedule settings, such as scheduling a vacation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `timezone` | string | No | Broadcaster time zone in IANA format; required when is_vacation_enabled is true. | | `broadcaster_id` | string | Yes | ID of the broadcaster whose schedule settings to update; must match the user ID in the access token. | | `vacation_end_time` | string | No | Vacation end time in RFC3339 format; required when is_vacation_enabled is true. | | `is_vacation_enabled` | boolean | No | Whether vacation mode is enabled. | | `vacation_start_time` | string | No | Vacation start time in RFC3339 format; required when is_vacation_enabled is true. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Channel Stream Schedule Segment **Slug:** `TWITCH_UPDATE_CHANNEL_STREAM_SCHEDULE_SEGMENT` Updates a scheduled broadcast segment. Changes to a recurring segment apply to every segment in its series. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the broadcast segment to update. | | `title` | string | No | New broadcast title. | | `duration` | string | No | New duration in minutes, from 30 through 1380. | | `timezone` | string | No | New IANA time zone. | | `start_time` | string | No | New RFC3339 start time; only partners and affiliates may change it, and only for non-recurring segments. | | `category_id` | string | No | New content category ID. | | `is_canceled` | boolean | No | Whether to cancel the segment. For a recurring series, Twitch cancels the next upcoming occurrence, which may not be the segment identified by id. | | `broadcaster_id` | string | Yes | ID of the broadcaster that owns the schedule. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Chat Settings **Slug:** `TWITCH_UPDATE_CHAT_SETTINGS` Updates the broadcaster’s chat settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `slow_mode` | boolean | No | A Boolean value that determines whether the broadcaster limits how often users in the chat room are allowed to send messages. Set to true if the broadcaster applies a wait period between messages; otherwise, false . The default is false . To specify the delay, see the slow_mode_wait_time field. | | `emote_mode` | boolean | No | A Boolean value that determines whether chat messages must contain only emotes. Set to true if only emotes are allowed; otherwise, false . The default is false . | | `moderator_id` | string | Yes | The ID of a user that has permission to moderate the broadcaster’s chat room, or the broadcaster’s ID if they’re making the update. This ID must match the user ID in the user access token. | | `follower_mode` | boolean | No | A Boolean value that determines whether the broadcaster restricts the chat room to followers only. Set to true if the broadcaster restricts the chat room to followers only; otherwise, false . The default is true . To specify how long users must follow the broadcaster before being able to participate in the chat room, see the follower_mode_duration field. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose chat settings you want to update. | | `subscriber_mode` | boolean | No | A Boolean value that determines whether only users that subscribe to the broadcaster’s channel may talk in the chat room. Set to true if the broadcaster restricts the chat room to subscribers only; otherwise, false . The default is false . | | `unique_chat_mode` | boolean | No | A Boolean value that determines whether the broadcaster requires users to post only unique messages in the chat room. Set to true if the broadcaster allows only unique messages; otherwise, false . The default is false . | | `slow_mode_wait_time` | integer | No | The amount of time, in seconds, that users must wait between sending messages. Set only if slow_mode is true . Possible values are: 3 (3 second delay) through 120 (2 minute delay). The default is 30 seconds. | | `follower_mode_duration` | integer | No | The length of time, in minutes, that users must follow the broadcaster before being able to participate in the chat room. Set only if follower_mode is true . Possible values are: 0 (no restriction) through 129600 (3 months). The default is 0. | | `non_moderator_chat_delay` | boolean | No | A Boolean value that determines whether the broadcaster adds a short delay before chat messages appear in the chat room. This gives chat moderators and bots a chance to remove them before viewers can see the message. Set to true if the broadcaster applies a delay; otherwise, false . The default is false . To specify the length of the delay, see the non_moderator_chat_delay_duration field. | | `non_moderator_chat_delay_duration` | integer ("2" | "4" | "6") | No | The amount of time, in seconds, that messages are delayed before appearing in chat. Set only if non_moderator_chat_delay is true . Possible values are: 2 — 2 second delay (recommended) 4 — 4 second delay 6 — 6 second delay | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Custom Reward **Slug:** `TWITCH_UPDATE_CUSTOM_REWARD` Updates a custom reward. Only the app that created the reward may update it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The ID of the reward to update. | | `cost` | integer | No | The cost of the reward, in channel points. The minimum is 1 point. | | `title` | string | No | The reward’s title. The title may contain a maximum of 45 characters and it must be unique amongst all of the broadcaster’s custom rewards. | | `prompt` | string | No | The prompt shown to the viewer when they redeem the reward. Specify a prompt if is_user_input_required is true . The prompt is limited to a maximum of 200 characters. | | `is_paused` | boolean | No | A Boolean value that determines whether to pause the reward. Set to true to pause the reward. Viewers can’t redeem paused rewards.. | | `is_enabled` | boolean | No | A Boolean value that indicates whether the reward is enabled. Set to true to enable the reward. Viewers see only enabled rewards. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that’s updating the reward. This ID must match the user ID found in the OAuth token. | | `max_per_stream` | integer | No | The maximum number of redemptions allowed per live stream. Applied only if is_max_per_stream_enabled is true . The minimum value is 1. | | `background_color` | string | No | The background color to use for the reward. Specify the color using Hex format (for example, \#00E5CB). | | `is_user_input_required` | boolean | No | A Boolean value that determines whether users must enter information to redeem the reward. Set to true if user input is required. See the prompt field. | | `global_cooldown_seconds` | integer | No | The cooldown period, in seconds. Applied only if is_global_cooldown_enabled is true . The minimum value is 1; however, for it to be shown in the Twitch UX, the minimum value is 60. | | `max_per_user_per_stream` | integer | No | The maximum number of redemptions allowed per user per stream. Applied only if is_max_per_user_per_stream_enabled is true . | | `is_max_per_stream_enabled` | boolean | No | A Boolean value that determines whether to limit the maximum number of redemptions allowed per live stream (see the max_per_stream field). Set to true to limit redemptions. | | `is_global_cooldown_enabled` | boolean | No | A Boolean value that determines whether to apply a cooldown period between redemptions. Set to true to apply a cooldown period. For the duration of the cooldown period, see global_cooldown_seconds . | | `is_max_per_user_per_stream_enabled` | boolean | No | A Boolean value that determines whether to limit the maximum number of redemptions allowed per user per stream (see max_per_user_per_stream ). The minimum value is 1. Set to true to limit redemptions. | | `should_redemptions_skip_request_queue` | boolean | No | A Boolean value that determines whether redemptions should be set to FULFILLED status immediately when a reward is redeemed. If false , status is set to UNFULFILLED and follows the normal request queue process. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Drops Entitlements **Slug:** `TWITCH_UPDATE_DROPS_ENTITLEMENTS` Updates the Drop entitlement’s fulfillment status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `entitlement_ids` | array | No | A list of up to 100 entitlement IDs to update. | | `fulfillment_status` | string ("CLAIMED" | "FULFILLED") | No | New status: CLAIMED means the user claimed the benefit; FULFILLED means the developer granted the claimed benefit. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Guest Star Slot **Slug:** `TWITCH_UPDATE_GUEST_STAR_SLOT` BETA Allows a user to update the assigned slot for a particular user within the active Guest Star session. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `session_id` | string | Yes | The ID of the Guest Star session in which to update slot settings. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user_id in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster running the Guest Star session. | | `source_slot_id` | string | Yes | The slot assignment previously assigned to a user. | | `destination_slot_id` | string | No | The slot to move this user assignment to. If the destination slot is occupied, the user assigned will be swapped into source_slot_id . | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Guest Star Slot Settings **Slug:** `TWITCH_UPDATE_GUEST_STAR_SLOT_SETTINGS` BETA Allows a user to update slot settings for a particular guest within a Guest Star session. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `volume` | integer | No | Value from 0-100 that controls the audio volume for shared views containing the slot. | | `is_live` | boolean | No | Flag indicating whether the user assigned to this slot is visible/can be heard from any public subscriptions. Generally, this determines whether or not the slot is enabled in any broadcasting software integrations. | | `slot_id` | string | Yes | The slot assignment that has previously been assigned to a user. | | `session_id` | string | Yes | The ID of the Guest Star session in which to update a slot’s settings. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the user access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster running the Guest Star session. | | `is_audio_enabled` | boolean | No | Flag indicating whether the slot is allowed to share their audio with the rest of the session. If false, the slot will be muted in any views containing the slot. | | `is_video_enabled` | boolean | No | Flag indicating whether the slot is allowed to share their video with the rest of the session. If false, the slot will have no video shared in any views containing the slot. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Pinned Chat Message **Slug:** `TWITCH_UPDATE_PINNED_CHAT_MESSAGE` Updates the duration of a pinned chat message. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `message_id` | string | Yes | The ID of the pinned message to update. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that owns the chat room. | | `duration_seconds` | integer | No | The new number of seconds the message should remain pinned, starting from now. Minimum: 30. Maximum: 1800. If not specified, the message will be pinned until the stream ends. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Redemption Status **Slug:** `TWITCH_UPDATE_REDEMPTION_STATUS` Updates a redemption’s status. Only an UNFULFILLED redemption may be updated, and only the app that created the reward may update it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | array | Yes | A list of IDs that identify the redemptions to update. To specify more than one ID, include this parameter for each redemption you want to update. For example, id=1234&id=5678 . You may specify a maximum of 50 IDs. | | `status` | string ("CANCELED" | "FULFILLED") | Yes | The status to set the redemption to. Possible values are: CANCELED FULFILLED Setting the status to CANCELED refunds the user’s channel points. | | `reward_id` | string | Yes | The ID that identifies the reward that’s been redeemed. | | `broadcaster_id` | string | Yes | The ID of the broadcaster that’s updating the redemption. This ID must match the user ID in the user access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Shield Mode Status **Slug:** `TWITCH_UPDATE_SHIELD_MODE_STATUS` Activates or deactivates the broadcaster’s Shield Mode. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `is_active` | boolean | Yes | A Boolean value that determines whether to activate Shield Mode. Set to true to activate Shield Mode; otherwise, false to deactivate Shield Mode. | | `moderator_id` | string | Yes | The ID of the broadcaster or a user that is one of the broadcaster’s moderators. This ID must match the user ID in the access token. | | `broadcaster_id` | string | Yes | The ID of the broadcaster whose Shield Mode you want to activate or deactivate. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update User **Slug:** `TWITCH_UPDATE_USER` Updates the user’s information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | No | New channel description for the authenticated user; an empty value clears it. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update User Chat Color **Slug:** `TWITCH_UPDATE_USER_CHAT_COLOR` Updates the color used for the user’s name in chat. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `color` | string | Yes | The color to use for the user's name in chat. All users may specify one of the following named color values. blue blue_violet cadet_blue chocolate coral dodger_blue firebrick golden_rod green hot_pink orange_red red sea_green spring_green yellow_green Turbo and Prime users may specify a named color or a Hex color code like #9146FF. If you use a Hex color code, remember to URL encode it. | | `user_id` | string | Yes | The ID of the user whose chat color you want to update. This ID must match the user ID in the access token. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update User Extensions **Slug:** `TWITCH_UPDATE_USER_EXTENSIONS` Updates an installed extension’s information. If the same extension is activated under multiple extension types, the last write wins, but write order is not guaranteed; avoid activating one extension under multiple types. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | object | Yes | Panel, overlay, and component extension configuration keyed by extension type. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Warn Chat User **Slug:** `TWITCH_WARN_CHAT_USER` Warns a user in the specified broadcaster’s chat room, preventing them from chat interaction until the warning is acknowledged. A new warning replaces any existing warning for that user in the channel. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | object | Yes | A list that contains information about the warning. | | `moderator_id` | string | Yes | The ID of the twitch user who requested the warning. | | `broadcaster_id` | string | Yes | The ID of the channel in which the warning will take effect. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |