Skip to main content
Twitch logo
  • Category: video & audio
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 131
  • Triggers: 0
  • Slug: TWITCH
  • Version: 20261101_00

Tools

Slug: TWITCH_ADD_BLOCKED_TERMAdds a word or phrase to the broadcaster’s list of blocked terms.

Input Parameters

string
required
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.
string
required
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.
string
required
The ID of the broadcaster that owns the list of blocked terms.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_ADD_CHANNEL_MODERATORAdds a moderator to the broadcaster’s chat room.

Input Parameters

string
required
The ID of the user to add as a moderator in the broadcaster’s chat room.
string
required
The ID of the broadcaster that owns the chat room. This ID must match the user ID in the access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_ADD_CHANNEL_VIPAdds the specified user as a VIP in the broadcaster’s channel.

Input Parameters

string
required
The ID of the user to give VIP status to.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_ADD_SUSPICIOUS_STATUS_TO_CHAT_USERAdds a suspicious user status to a chatter on the broadcaster’s channel.

Input Parameters

string ("ACTIVE_MONITORING" | "RESTRICTED")
required
Suspicious-user status to apply: ACTIVE_MONITORING or RESTRICTED.
string
required
The ID of the chatter receiving the suspicious-user status.
string
required
The user ID of the moderator who is applying the status.
string
required
The user ID of the broadcaster, indicating the channel where the status is being applied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_ASSIGN_GUEST_STAR_SLOTBETA Allows a previously invited user to be assigned a slot within the active Guest Star session.

Input Parameters

string
required
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 .
string
required
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.
string
required
The ID of the Guest Star session in which to assign the slot.
string
required
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.
string
required
The ID of the broadcaster running the Guest Star session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_BAN_USERBans a user from participating in a broadcaster’s chat room or puts them in a timeout.

Input Parameters

object
required
Identifies the user and type of ban.
string
required
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.
string
required
The ID of the broadcaster whose chat room the user is being banned from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_BLOCK_USERBlocks the specified user from interacting with or having contact with the broadcaster.

Input Parameters

string ("harassment" | "spam" | "other")
Optional reason for the block; omit it or specify harassment, spam, or other.
string ("chat" | "whisper")
Context in which the block occurred: chat, whisper, or empty.
string
required
ID of the user to block.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_CANCEL_A_RAIDCancel a pending raid.

Input Parameters

string
required
The ID of the broadcaster that initiated the raid. This ID must match the user ID in the user access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_CHECK_AUTOMOD_STATUSChecks messages against a broadcaster’s AutoMod settings and blocked terms, indicating whether Twitch would permit each message or hold it for review or block it.

Input Parameters

array
required
The list of messages to check. The list must contain at least one message and may contain up to a maximum of 100 messages.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_CHECK_USER_SUBSCRIPTIONChecks whether the authenticated user subscribes to a specified broadcaster’s channel. Twitch returns a 404 when the user is not subscribed.

Input Parameters

string
required
ID of the authenticated user whose subscription to check.
string
required
ID of the broadcaster to check.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_CREATE_CHANNEL_STREAM_SCHEDULE_SEGMENTAdds a single or recurring broadcast to the broadcaster’s streaming schedule.

Input Parameters

string
Broadcast title, up to 140 characters.
string
required
Scheduled duration in minutes, from 30 through 1380.
string
required
Broadcast time zone in IANA format.
string
required
Broadcast start time in RFC3339 format.
string
Category ID for the broadcast content.
boolean
Whether the broadcast recurs weekly. Only partners and affiliates may add non-recurring broadcasts.
string
required
ID of the broadcaster that owns the schedule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_CREATE_CLIPStarts 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

string
The title of the clip.
number
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.
string
required
The ID of the broadcaster whose stream you want to create a clip from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_CREATE_CLIP_FROM_VODStarts 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

string
required
The title of the clip.
string
required
ID of the VOD the user wants to clip.
number
The length of the clip, in seconds. Precision is 0.1. Defaults to 30. Min: 5 seconds, Max: 60 seconds.
string
required
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.
integer
required
The zero-based offset where the clip ends. It must be at least duration and less than the VOD’s duration.
string
required
The user ID for the channel you want to create a clip for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_CREATE_CUSTOM_REWARDSCreates a Custom Reward in the broadcaster’s channel.

Input Parameters

integer
required
The cost of the reward, in Channel Points. The minimum is 1 point.
string
required
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.
string
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.
boolean
A Boolean value that determines whether the reward is enabled. Viewers see only enabled rewards. The default is true .
string
required
The ID of the broadcaster to add the custom reward to. This ID must match the user ID found in the OAuth token.
integer
The maximum number of redemptions allowed per live stream. Applied only if is_max_per_stream_enabled is true . The minimum value is 1.
string
The background color to use for the reward. Specify the color using Hex format (for example, #9147FF).
boolean
A Boolean value that determines whether the user needs to enter information when redeeming the reward. See the prompt field. The default is false .
integer
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.
integer
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.
boolean
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 .
boolean
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 .
boolean
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 .
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_CREATE_EVENTSUB_SUBSCRIPTIONCreates 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

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")
required
EventSub type supported for WebSocket delivery with user OAuth. The selected type determines the conditional OAuth scope requirement published by this action.
string
required
Exact supported version for the selected WebSocket/user-OAuth EventSub type.
object
required
Subscription-type-specific condition fields and values.
object
required
WebSocket notification transport associated with the user OAuth token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_CREATE_GUEST_STAR_SESSIONCreates a beta Guest Star session on behalf of the broadcaster. The broadcaster must be present in the call interface or the call will end automatically.

Input Parameters

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_CREATE_POLLCreates a poll that viewers in the broadcaster’s channel can vote on.

Input Parameters

string
required
The question that viewers will vote on. For example, What game should I play next? The question may contain a maximum of 60 characters.
array
required
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.
integer
required
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).
string
required
The ID of the broadcaster that’s running the poll. This ID must match the user ID in the user access token.
integer
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 .
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_CREATE_PREDICTIONCreate a Channel Points Prediction.

Input Parameters

string
required
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.
array
required
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.
string
required
The ID of the broadcaster that’s running the prediction. This ID must match the user ID in the user access token.
integer
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_CREATE_STREAM_MARKERAdds a marker to a live stream.

Input Parameters

string
required
ID of the broadcaster whose live stream to mark; must match the user ID in the access token.
string
Optional marker description, up to 140 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_DELETE_CHANNEL_STREAM_SCHEDULE_SEGMENTDeletes a broadcast segment from the broadcaster’s streaming schedule. Deleting a recurring segment removes the entire recurring series.

Input Parameters

string
required
ID of the broadcast segment to remove.
string
required
ID of the broadcaster that owns the schedule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_DELETE_CHAT_MESSAGESRemoves a single chat message or all chat messages from the broadcaster’s chat room. Omitting the message ID removes all messages.

Input Parameters

string
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.
string
required
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.
string
required
The ID of the broadcaster that owns the chat room to remove messages from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_DELETE_CUSTOM_REWARDDeletes a custom reward that the broadcaster created.

Input Parameters

string
required
The ID of the custom reward to delete.
string
required
The ID of the broadcaster that created the custom reward. This ID must match the user ID found in the OAuth token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_DELETE_EVENTSUB_SUBSCRIPTIONDeletes a WebSocket EventSub subscription by ID using the connected user OAuth token.

Input Parameters

string
required
ID of the EventSub subscription to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_DELETE_GUEST_STAR_INVITEBETA Revokes a previously sent invite for a Guest Star session.

Input Parameters

string
required
Twitch User ID for the guest to revoke the Guest Star session invite from.
string
required
The ID of the session for the invite to be revoked on behalf of the broadcaster.
string
required
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.
string
required
The ID of the broadcaster running the Guest Star session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_DELETE_GUEST_STAR_SLOTBETA Removes a guest’s slot assignment from an active Guest Star session, immediately revoking session and media access. The guest may optionally be reinvited to the queue.

Input Parameters

string
required
The slot ID representing the slot assignment to remove from the session.
string
required
The Twitch User ID corresponding to the guest to remove from the session.
string
required
The ID of the Guest Star session in which to remove the slot assignment.
string
required
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.
string
required
The ID of the broadcaster running the Guest Star session.
boolean
Flag signaling that the guest should be reinvited to the session, sending them back to the invite queue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_DELETE_VIDEOSDeletes one or more videos.

Input Parameters

array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_END_GUEST_STAR_SESSIONBETA Programmatically ends a Guest Star session on behalf of the broadcaster.

Input Parameters

string
required
ID for the session to end on behalf of the broadcaster.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_END_POLLEnds an active poll, optionally archiving it so it is no longer publicly visible.

Input Parameters

string
required
The ID of the poll to update.
string ("TERMINATED" | "ARCHIVED")
required
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.
string
required
The ID of the broadcaster that’s running the poll. This ID must match the user ID in the user access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_END_PREDICTIONLocks, resolves, or cancels a Channel Points Prediction.

Input Parameters

string
required
The ID of the prediction to update.
string ("RESOLVED" | "CANCELED" | "LOCKED")
required
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.
string
required
The ID of the broadcaster that’s running the prediction. This ID must match the user ID in the user access token.
string
The ID of the winning outcome. You must set this parameter if you set status to RESOLVED.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_AD_SCHEDULEReturns 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

string
required
Provided broadcaster_id must match the user_id in the auth token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_ALL_STREAM_TAGSDeprecated: this endpoint was retired and returns HTTP 410 Gone. Use GET_CHANNEL_INFORMATION and its tags field instead.

Input Parameters

string
Continuation cursor returned by a previous call.
integer
Maximum tags to return.
array
Specific stream tag IDs to retrieve, up to 100 IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_AUTOMOD_SETTINGSGets the broadcaster’s AutoMod settings.

Input Parameters

string
required
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.
string
required
The ID of the broadcaster whose AutoMod settings you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_BANNED_USERSGets 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

string
Provider cursor for an initial forward page request.
integer
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.
string
Provider cursor for an initial backward page request.
string
Opaque continuation cursor returned by this action.
array
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.
string
required
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.
string ("forward" | "backward")
Continuation direction. Set automatically from before and preserved in opaque cursors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_BITS_LEADERBOARDGets the Bits leaderboard for the authenticated broadcaster.

Input Parameters

integer
The number of results to return. The minimum count is 1 and the maximum is 100. The default is 10.
string ("day" | "week" | "month" | "year" | "all")
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.
string
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.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_BLOCKED_TERMSGets the broadcaster’s list of non-private, blocked words or phrases.

Input Parameters

string
The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value.
integer
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.
string
required
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.
string
required
The ID of the broadcaster whose blocked terms you’re getting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_BROADCASTER_SUBSCRIPTIONSGets a list of users that subscribe to the specified broadcaster.

Input Parameters

string
Provider cursor for an initial forward page request.
integer
Maximum subscriptions to return (1-100).
string
Provider cursor for an initial backward page request.
string
Opaque continuation cursor returned by this action.
array
Subscriber user IDs to filter by, up to 100 subscribers.
string
required
ID of the broadcaster whose subscriptions to retrieve.
string ("forward" | "backward")
Continuation direction. Set automatically from before and preserved in opaque cursors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CHANNEL_CHAT_BADGESGets the broadcaster’s list of custom chat badges.

Input Parameters

string
required
The ID of the broadcaster whose chat badges you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CHANNEL_EDITORSGets the broadcaster’s list editors.

Input Parameters

string
required
The ID of the broadcaster that owns the channel. This ID must match the user ID in the access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CHANNEL_EMOTESGets the broadcaster’s list of custom emotes.

Input Parameters

string
required
An ID that identifies the broadcaster whose emotes you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CHANNEL_FOLLOWERSGets 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

string
The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read more .
integer
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.
string
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.
string
required
The broadcaster’s ID. Returns the list of users that follow this broadcaster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CHANNEL_GUEST_STAR_SETTINGSBETA Gets the channel settings for configuration of the Guest Star feature for a particular host.

Input Parameters

string
required
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.
string
required
The ID of the broadcaster you want to get guest star settings for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CHANNEL_ICALENDARGets the broadcaster’s streaming schedule as an iCalendar .

Input Parameters

string
required
ID of the broadcaster whose schedule to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CHANNEL_INFORMATIONGets information about one or more channels.

Input Parameters

array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CHANNEL_STREAM_SCHEDULEGets the broadcaster’s streaming schedule.

Input Parameters

array
Scheduled segment IDs to retrieve; include id once per segment, up to 100 IDs.
string
Continuation cursor returned by a previous call.
integer
Maximum segments to return.
string
RFC3339 start time used to filter the schedule.
integer
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.
string
required
ID of the broadcaster whose schedule to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CHANNEL_TEAMSGets the list of Twitch teams that the broadcaster is a member of.

Input Parameters

string
required
ID of the broadcaster whose teams to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CHARITY_CAMPAIGNGets information about the broadcaster’s active charity campaign.

Input Parameters

string
required
The ID of the broadcaster that’s currently running a charity campaign. This ID must match the user ID in the access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CHARITY_CAMPAIGN_DONATIONSGets the list of donations that users have made to the broadcaster’s active charity campaign.

Input Parameters

string
The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read More
integer
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.
string
required
The ID of the broadcaster that’s currently running a charity campaign. This ID must match the user ID in the access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CHAT_SETTINGSGets the broadcaster’s chat settings.

Input Parameters

string
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.
string
required
The ID of the broadcaster whose chat settings you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CHATTERSGets the list of users that are connected to the broadcaster’s chat session.

Input Parameters

string
The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read More
integer
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.
string
required
The ID of the broadcaster or one of the broadcaster’s moderators. This ID must match the user ID in the user access token.
string
required
The ID of the broadcaster whose list of chatters you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CHEERMOTESGets a list of Cheermotes that users can use to cheer Bits.

Input Parameters

string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CLIPSGets clips selected by exactly one broadcaster ID, game ID, or list of clip IDs.

Input Parameters

array
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.
string
Provider cursor for an initial forward page request.
integer
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.
string
Provider cursor for an initial backward page request.
string
Opaque continuation cursor returned by this action.
string
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.
string
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.
string
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.
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.
string
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.
string ("forward" | "backward")
Continuation direction. Set automatically from before and preserved in opaque cursors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CLIPS_DOWNLOADGets temporary download URLs for the specified clips. Landscape or portrait URLs may be unavailable, and the links are expected to expire.

Input Parameters

array
required
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 .
string
required
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.
string
required
The ID of the broadcaster you want to download clips for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CONTENT_CLASSIFICATION_LABELSGets information about Twitch content classification labels.

Input Parameters

string
BCP-47 locale for localized label descriptions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CREATOR_GOALSGets the broadcaster’s list of active goals.

Input Parameters

string
required
The ID of the broadcaster that created the goals. This ID must match the user ID in the user access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CUSTOM_POWER_UPGets a list of custom Power-ups that the specified broadcaster created.

Input Parameters

array
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.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CUSTOM_REWARDGets a list of custom rewards that the specified broadcaster created.

Input Parameters

array
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.
string
required
The ID of the broadcaster whose custom rewards you want to get. This ID must match the user ID found in the OAuth token.
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_CUSTOM_REWARD_REDEMPTIONGets a list of redemptions for a custom reward.

Input Parameters

array
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.
string ("OLDEST" | "NEWEST")
The order to sort redemptions by. The possible case-sensitive values are: OLDEST NEWEST The default is OLDEST.
string
The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read more
integer
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.
string ("CANCELED" | "FULFILLED" | "UNFULFILLED")
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.
string
required
The ID that identifies the custom reward whose redemptions you want to get.
string
required
The ID of the broadcaster that owns the custom reward. This ID must match the user ID found in the user OAuth token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_DROPS_ENTITLEMENTSGets Drops entitlements granted to the user in the OAuth token, optionally filtered by entitlement ID, game, or fulfillment status.

Input Parameters

array
Entitlement IDs to retrieve; include id once per entitlement, up to 100 IDs.
string
Continuation cursor returned by a previous call.
integer
Maximum entitlements on this page (1-1000).
string
Game ID filter; results remain limited to the user in the OAuth token.
string ("CLAIMED" | "FULFILLED")
Filter by CLAIMED or FULFILLED status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_EMOTE_SETSGets emotes for one or more specified emote sets.

Input Parameters

array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_EVENTSUB_SUBSCRIPTIONSLists WebSocket EventSub subscriptions associated with the connected user OAuth token.

Input Parameters

string
Filter by subscription type.
string
Continuation cursor returned by a previous call.
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")
Filter by subscription status.
string
Filter by user ID present in the condition.
string
Filter by one subscription ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_EXTENSION_ANALYTICSGets download URLs for CSV analytics reports for one or more extensions. The URLs are valid for five minutes.

Input Parameters

string
The type of analytics report to get. Possible values are: overview_v2
string
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.
integer
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.
string
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.
string
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.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_EXTENSION_LIVE_CHANNELSGets a list of broadcasters that are streaming live and have installed or activated the extension.

Input Parameters

string
Continuation cursor returned by a previous call.
integer
Maximum live channels on this page (1-100).
string
required
Extension Client ID whose live channels to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_FOLLOWED_CHANNELSGets 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

string
The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read more .
integer
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.
string
required
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.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_FOLLOWED_STREAMSGets the list of broadcasters that the user follows and that are streaming live.

Input Parameters

string
Continuation cursor returned by a previous call.
integer
Maximum streams to return.
string
required
ID of the authenticated user whose followed live streams to retrieve; must match the user ID in the access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_GAME_ANALYTICSGets download URLs for CSV analytics reports for one or more games. The URLs are valid for five minutes.

Input Parameters

string
The type of analytics report to get. Possible values are: overview_v2
string
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.
integer
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.
string
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.
string
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.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_GAMESGets information about specified Twitch categories or games by ID, exact name, or IGDB ID.

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_GLOBAL_CHAT_BADGESGets Twitch’s list of chat badges.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_GLOBAL_EMOTESGets all global emotes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_GUEST_STAR_INVITESBETA Provides the caller with a list of pending invites to a Guest Star session.

Input Parameters

string
required
The session ID to query for invite status.
string
required
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.
string
required
The ID of the broadcaster running the Guest Star session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_GUEST_STAR_SESSIONBETA Gets information about an ongoing Guest Star session for a particular channel.

Input Parameters

string
required
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.
string
required
ID for the user hosting the Guest Star session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_HYPE_TRAIN_STATUSGets the status of a Hype Train for the specified broadcaster.

Input Parameters

string
required
The User ID of the channel broadcaster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_MODERATED_CHANNELSGets a list of channels that the specified user has moderator privileges in.

Input Parameters

string
The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value.
integer
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.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_MODERATORSGets all users allowed to moderate the broadcaster’s chat room.

Input Parameters

string
The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read More
integer
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.
array
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.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_PINNED_CHAT_MESSAGEGets the currently pinned message for the broadcaster’s chat room.

Input Parameters

string
required
The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room.
string
required
The ID of the broadcaster that owns the chat room.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_POLLSGets a list of polls created by the broadcaster, optionally filtered by poll IDs. Polls are available for 90 days after creation.

Input Parameters

array
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.
string
The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read More
integer
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.
string
required
The ID of the broadcaster that created the polls. This ID must match the user ID in the user access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_PREDICTIONSGets a list of Channel Points Predictions that the broadcaster created.

Input Parameters

array
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.
string
The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read More
integer
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.
string
required
The ID of the broadcaster whose predictions you want to get. This ID must match the user ID in the user access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_RELEASED_EXTENSIONSGets information about a released extension.

Input Parameters

string
required
Released Extension Client ID to retrieve.
string
Specific released version; omit for the latest released version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_SHARED_CHAT_SESSIONRetrieves the active shared chat session for a channel.

Input Parameters

string
required
The User ID of the channel broadcaster.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_SHIELD_MODE_STATUSGets the broadcaster’s Shield Mode activation status.

Input Parameters

string
required
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.
string
required
The ID of the broadcaster whose Shield Mode activation status you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_STREAM_KEYSENSITIVE: 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

string
required
ID of the broadcaster whose stream key to retrieve; must match the token user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_STREAM_MARKERSGets markers from either a user’s most recent stream or one specified VOD; provide exactly one selector.

Input Parameters

string
Provider cursor for an initial forward page request.
integer
Maximum videos to return per page.
string
Provider cursor for an initial backward page request.
string
Opaque continuation cursor returned by this action.
string
Broadcaster user ID whose stream markers to retrieve.
string
Video ID whose stream markers to retrieve.
string ("forward" | "backward")
Continuation direction. Set automatically from before and preserved in opaque cursors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_STREAMSGets a list of all streams.

Input Parameters

string ("all" | "live")
Stream type filter; currently use all or live.
string
Provider cursor for an initial forward page request.
integer
Maximum streams to return.
string
Provider cursor for an initial backward page request.
string
Opaque continuation cursor returned by this action.
array
Game or category IDs used to filter streams.
array
User IDs used to filter streams.
array
ISO 639-1 stream language filters; use other for streams without a supported language code.
array
User login names used to filter streams.
string ("forward" | "backward")
Continuation direction. Set automatically from before and preserved in opaque cursors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_STREAM_TAGSDeprecated: this endpoint was retired and returns HTTP 410 Gone. Use GET_CHANNEL_INFORMATION and its tags field instead.

Input Parameters

string
required
ID of the broadcaster whose stream tags to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_TEAMSGets one Twitch team by exactly one team name or team ID.

Input Parameters

string
Team ID to retrieve.
string
Team name to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_TOP_GAMESGets games and categories ranked by current viewer count on Twitch.

Input Parameters

string
Provider cursor for an initial forward page request.
integer
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.
string
Provider cursor for an initial backward page request.
string
Opaque continuation cursor returned by this action.
string ("forward" | "backward")
Continuation direction. Set automatically from before and preserved in opaque cursors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_UNBAN_REQUESTSGets a list of unban requests for a broadcaster’s channel.

Input Parameters

string
Cursor used to get next page of results. Pagination object in response contains cursor value.
integer
The maximum number of items to return per page in response
string ("pending" | "approved" | "denied" | "acknowledged" | "canceled")
required
Filter by a status. pending approved denied acknowledged canceled
string
The ID used to filter what unban requests are returned.
string
required
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.
string
required
The ID of the broadcaster whose channel is receiving unban requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_USER_ACTIVE_EXTENSIONSGets the active extensions that the broadcaster has installed for each configuration.

Input Parameters

string
Broadcaster ID. Omit it to use the broadcaster represented by the connected user access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_USER_BLOCK_LISTGets the list of users that the broadcaster has blocked.

Input Parameters

string
Continuation cursor returned by a previous call.
integer
Maximum blocked users to return.
string
required
ID of the authenticated user whose block list to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_USER_CHAT_COLORGets the color used for the user’s name in chat.

Input Parameters

array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_USER_EMOTESRetrieves emotes available to the user across all channels.

Input Parameters

string
The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value.
string
required
The ID of the user. This ID must match the user ID in the user access token.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_USER_EXTENSIONSGets a list of all extensions (both active and inactive) that the broadcaster has installed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_USERSGets information about one or more users. With no id or login selectors, returns the user represented by the access token.

Input Parameters

array
User IDs to retrieve.
array
User login names to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_VIDEOSGets published videos selected by exactly one list of video IDs, broadcaster ID, or game ID.

Input Parameters

array
Video ID filter; mutually exclusive with user_id and game_id.
string ("time" | "trending" | "views")
Sort order for user_id or game_id: time, trending, or views.
string ("all" | "archive" | "highlight" | "upload")
Video type filter for user_id or game_id: all, archive, highlight, or upload.
string
Provider cursor for an initial forward page request.
integer
Maximum videos per page; applies only with user_id or game_id.
string
Provider cursor for an initial backward page request.
string
Opaque continuation cursor returned by this action.
string ("all" | "day" | "month" | "week")
Published-period filter for user_id or game_id: all, day, month, or week.
string
Category ID filter; mutually exclusive with id and user_id.
string
Broadcaster ID filter; mutually exclusive with id and game_id.
string
ISO 639-1 broadcast language filter; applies only with user_id or game_id.
string ("forward" | "backward")
Continuation direction. Set automatically from before and preserved in opaque cursors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_GET_VIPSGets a list of the broadcaster’s VIPs.

Input Parameters

string
The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read More
integer
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.
array
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.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_MANAGE_HELD_AUTOMOD_MESSAGESAllows or denies one message that AutoMod held for review.

Input Parameters

string ("ALLOW" | "DENY")
required
The action to take for the message. Possible values are: ALLOW DENY
string
required
The ID of the message to allow or deny.
string
required
The moderator who is approving or denying the held message. This ID must match the user ID in the access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_MODIFY_CHANNEL_INFORMATIONUpdates a channel’s properties.

Input Parameters

array
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.
integer
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).
string
The title of the user’s stream. You may not set this field to an empty string.
string
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).
string
required
The ID of the broadcaster whose channel you want to update. This ID must match the user ID in the user access token.
boolean
Boolean flag indicating if the channel has branded content.
string
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.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_PIN_CHAT_MESSAGEPins a chat message in the specified broadcaster’s chat room, replacing any existing mod-pinned message.

Input Parameters

string
required
The ID of the message to pin.
string
required
The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room.
string
required
The ID of the broadcaster that owns the chat room.
integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_REMOVE_BLOCKED_TERMRemoves the word or phrase from the broadcaster’s list of blocked terms.

Input Parameters

string
required
The ID of the blocked term to remove from the broadcaster’s list of blocked terms.
string
required
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.
string
required
The ID of the broadcaster that owns the list of blocked terms.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_REMOVE_CHANNEL_MODERATORRemoves a moderator from the broadcaster’s chat room.

Input Parameters

string
required
The ID of the user to remove as a moderator from the broadcaster’s chat room.
string
required
The ID of the broadcaster that owns the chat room. This ID must match the user ID in the access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_REMOVE_CHANNEL_VIPRemoves the specified user as a VIP in the broadcaster’s channel.

Input Parameters

string
required
The ID of the user to remove VIP status from.
string
required
The ID of the broadcaster who owns the channel where the user has VIP status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_REMOVE_SUSPICIOUS_STATUS_FROM_CHAT_USERRemove a suspicious user status from a chatter on broadcaster’s channel.

Input Parameters

string
required
The ID of the user having the suspicious status removed.
string
required
The user ID of the moderator who is removing the status.
string
required
The user ID of the broadcaster, indicating the channel where the status is being removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_RESOLVE_UNBAN_REQUESTSResolves an unban request by approving or denying it.

Input Parameters

string ("approved" | "denied")
required
Resolution status. approved denied
string
required
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.
string
required
The ID of the broadcaster whose channel is approving or denying the unban request.
string
Message supplied by the unban request resolver. The message is limited to a maximum of 500 characters.
string
required
The ID of the Unban Request to resolve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_SEARCH_CATEGORIESGets the games or categories that match the specified query.

Input Parameters

string
Continuation cursor returned by a previous call.
integer
Maximum categories to return.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_SEARCH_CHANNELSSearches channels that streamed within the past six months using a case-insensitive prefix query. By default it matches broadcaster login names; live-only searches match broadcaster names or categories.

Input Parameters

string
Continuation cursor returned by a previous call.
integer
Maximum channels to return.
string
required
Raw, case-insensitive prefix search term for broadcaster channels; the transport applies URI encoding.
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_SEND_A_SHOUTOUTSends a Shoutout to the specified broadcaster.

Input Parameters

string
required
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.
string
required
The ID of the broadcaster that’s receiving the Shoutout.
string
required
The ID of the broadcaster that’s sending the Shoutout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_SEND_CHAT_ANNOUNCEMENTSends 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

string ("blue" | "green" | "orange" | "purple" | "primary")
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 ).
string
required
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.
string
required
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.
string
required
The ID of the broadcaster that owns the chat room to send the announcement to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_SEND_CHAT_MESSAGESends 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

boolean
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.
string
required
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
string
required
The ID of the user sending the message. This ID must match the user ID in the user access token.
string
required
The ID of the broadcaster whose chat room the message will be sent to.
string
The ID of the chat message being replied to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_SEND_GUEST_STAR_INVITEBETA Sends an invite to a specified guest on behalf of the broadcaster for a Guest Star session in progress.

Input Parameters

string
required
Twitch User ID for the guest to invite to the Guest Star session.
string
required
The session ID for the invite to be sent on behalf of the broadcaster.
string
required
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.
string
required
The ID of the broadcaster running the Guest Star session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_SEND_WHISPERRequests 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

string
required
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.
string
required
ID of the user receiving the whisper.
string
required
ID of the verified user sending the whisper; must match the token user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_SNOOZE_NEXT_ADPushes back the timestamp of the upcoming automatic mid-roll ad by 5 minutes.

Input Parameters

string
required
Provided broadcaster_id must match the user_id in the auth token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_START_A_RAIDInitiates 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

string
required
The ID of the broadcaster to raid.
string
required
The ID of the broadcaster that’s sending the raiding party. This ID must match the user ID in the user access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_START_COMMERCIALStarts 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

integer
required
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.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_UNBAN_USERRemoves the ban or timeout that was placed on the specified user.

Input Parameters

string
required
The ID of the user to remove the ban or timeout from.
string
required
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.
string
required
The ID of the broadcaster whose chat room the user is banned from chatting in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_UNBLOCK_USERRemoves the user from the broadcaster’s list of blocked users.

Input Parameters

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_UNPIN_CHAT_MESSAGEUnpins a pinned chat message from the broadcaster’s chat room.

Input Parameters

string
required
The ID of the message to unpin.
string
required
The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room.
string
required
The ID of the broadcaster that owns the chat room.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_UPDATE_AUTOMOD_SETTINGSUpdates the broadcaster’s AutoMod settings. This overwrites the settings: include all individual levels you want retained, or set the overall level instead.

Input Parameters

integer
The Automod level for hostility involving name calling or insults.
integer
The Automod level for discrimination against women.
integer
The Automod level for profanity.
integer
The AutoMod level for hostility involving aggression, from 0 through 4.
integer
The Automod level for discrimination against disability.
string
required
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.
integer
The default AutoMod level for the broadcaster, from 0 through 4. Do not combine with individual levels.
string
required
The ID of the broadcaster whose AutoMod settings you want to update.
integer
The Automod level for sexual content.
integer
The AutoMod level for discrimination based on sexuality, sex, or gender.
integer
The Automod level for racial discrimination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_UPDATE_CHANNEL_GUEST_STAR_SETTINGSBETA Updates Guest Star channel settings; regenerating browser sources immediately invalidates all previously configured browser sources.

Input Parameters

integer
Number of slots the Guest Star call interface will allow the host to add to a call. Required to be between 1 and 6.
string ("TILED_LAYOUT" | "SCREENSHARE_LAYOUT" | "HORIZONTAL_LAYOUT" | "VERTICAL_LAYOUT")
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
string
required
The ID of the broadcaster you want to update Guest Star settings for.
boolean
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.
boolean
Flag determining if Guest Star moderators have access to control whether a guest is live once assigned to a slot.
boolean
Flag determining if Browser Sources subscribed to sessions on this channel should output audio

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_UPDATE_CHANNEL_STREAM_SCHEDULEUpdates the broadcaster’s schedule settings, such as scheduling a vacation.

Input Parameters

string
Broadcaster time zone in IANA format; required when is_vacation_enabled is true.
string
required
ID of the broadcaster whose schedule settings to update; must match the user ID in the access token.
string
Vacation end time in RFC3339 format; required when is_vacation_enabled is true.
boolean
Whether vacation mode is enabled.
string
Vacation start time in RFC3339 format; required when is_vacation_enabled is true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_UPDATE_CHANNEL_STREAM_SCHEDULE_SEGMENTUpdates a scheduled broadcast segment. Changes to a recurring segment’s title, category, duration or time zone apply to the entire series; cancellation instead affects the next upcoming occurrence.

Input Parameters

string
required
ID of the broadcast segment to update.
string
New broadcast title.
string
New duration in minutes, from 30 through 1380.
string
New IANA time zone.
string
New RFC3339 start time; only partners and affiliates may change it, and only for non-recurring segments.
string
New content category ID.
boolean
Whether to cancel the segment. For a recurring series, Twitch cancels the next upcoming occurrence, which may not be the segment identified by id.
string
required
ID of the broadcaster that owns the schedule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_UPDATE_CHAT_SETTINGSUpdates the broadcaster’s chat settings.

Input Parameters

boolean
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.
boolean
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 .
string
required
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.
boolean
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.
string
required
The ID of the broadcaster whose chat settings you want to update.
boolean
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 .
boolean
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 .
integer
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.
integer
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.
boolean
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.
integer ("2" | "4" | "6")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_UPDATE_CUSTOM_REWARDUpdates a custom reward. Only the app that created the reward may update it.

Input Parameters

string
required
The ID of the reward to update.
integer
The cost of the reward, in channel points. The minimum is 1 point.
string
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.
string
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.
boolean
A Boolean value that determines whether to pause the reward. Set to true to pause the reward. Viewers can’t redeem paused rewards..
boolean
A Boolean value that indicates whether the reward is enabled. Set to true to enable the reward. Viewers see only enabled rewards.
string
required
The ID of the broadcaster that’s updating the reward. This ID must match the user ID found in the OAuth token.
integer
The maximum number of redemptions allowed per live stream. Applied only if is_max_per_stream_enabled is true . The minimum value is 1.
string
The background color to use for the reward. Specify the color using Hex format (for example, #00E5CB).
boolean
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.
integer
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.
integer
The maximum number of redemptions allowed per user per stream. Applied only if is_max_per_user_per_stream_enabled is true .
boolean
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.
boolean
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 .
boolean
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.
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_UPDATE_DROPS_ENTITLEMENTSUpdates Drops entitlements’ fulfillment status. The response groups entitlement IDs by outcome; a successful request does not mean every update succeeded.

Input Parameters

array
A list of up to 100 entitlement IDs to update.
string ("CLAIMED" | "FULFILLED")
New status: CLAIMED means the user claimed the benefit; FULFILLED means the developer granted the claimed benefit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_UPDATE_GUEST_STAR_SLOTBETA Updates a user’s assigned slot in an active Guest Star session. Moving to an occupied slot swaps its occupant into the source slot.

Input Parameters

string
required
The ID of the Guest Star session in which to update slot settings.
string
required
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.
string
required
The ID of the broadcaster running the Guest Star session.
string
required
The slot assignment previously assigned to a user.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_UPDATE_GUEST_STAR_SLOT_SETTINGSBETA Allows a user to update slot settings for a particular guest within a Guest Star session.

Input Parameters

integer
Value from 0-100 that controls the audio volume for shared views containing the slot.
boolean
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.
string
required
The slot assignment that has previously been assigned to a user.
string
required
The ID of the Guest Star session in which to update a slot’s settings.
string
required
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.
string
required
The ID of the broadcaster running the Guest Star session.
boolean
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.
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_UPDATE_PINNED_CHAT_MESSAGEUpdates the duration of a pinned chat message.

Input Parameters

string
required
The ID of the pinned message to update.
string
required
The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room.
string
required
The ID of the broadcaster that owns the chat room.
integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_UPDATE_REDEMPTION_STATUSUpdates a redemption’s status. Only an UNFULFILLED redemption may be updated, and only the app that created the reward may update it.

Input Parameters

array
required
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.
string ("CANCELED" | "FULFILLED")
required
The status to set the redemption to. Possible values are: CANCELED FULFILLED Setting the status to CANCELED refunds the user’s channel points.
string
required
The ID that identifies the reward that’s been redeemed.
string
required
The ID of the broadcaster that’s updating the redemption. This ID must match the user ID in the user access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_UPDATE_SHIELD_MODE_STATUSActivates or deactivates the broadcaster’s Shield Mode.

Input Parameters

boolean
required
A Boolean value that determines whether to activate Shield Mode. Set to true to activate Shield Mode; otherwise, false to deactivate Shield Mode.
string
required
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.
string
required
The ID of the broadcaster whose Shield Mode you want to activate or deactivate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_UPDATE_USERUpdates the authenticated user’s channel description; an empty description clears it.

Input Parameters

string
New channel description for the authenticated user; an empty value clears it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_UPDATE_USER_CHAT_COLORUpdates the color used for the user’s name in chat.

Input Parameters

string
required
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.
string
required
The ID of the user whose chat color you want to update. This ID must match the user ID in the access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_UPDATE_USER_EXTENSIONSUpdates 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

object
required
Panel, overlay, and component extension configuration keyed by extension type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TWITCH_WARN_CHAT_USERWarns 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

object
required
A list that contains information about the warning.
string
required
The ID of the twitch user who requested the warning.
string
required
The ID of the channel in which the warning will take effect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not