SCALAR
ID
The ID
scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4"
) or integer (such as 4
) input value will be accepted as an ID.
link GraphQL Schema definition
1 scalar ID
link Required by
- AcceptFriendRequestInput
- AcceptOrganizationInviteInputInput to the AcceptOrganiztaionInvite mutation.
- AcceptProgramAgreementInputAcceptProgramAgreementInput is the input required when accepting a program agreement.
- AcceptSquadStreamInvitationInputInputs to the acceptSquadStreamInvitation mutation.
- AcknowledgePredictionResultInputAcknowledge the results of a Prediction.
- AcknowledgeSubscriptionStateInputAcknowledgeSubscriptionStateInput updates the state of the given subscription to aknowledged.
- AcknowledgeUnbanRequestInputRequired input to acknowledge an unban request on a channel.
- ActivateExtensionInputThe input to be provided to the activateExtension mutation.
- ADASPropertiesAmazon Digital Ad Service Properties.
- AdContextThe context returned for the current ad request.
- AdCreativeAdvertising creative.
- AddAutohostChannelsInputAddAutohostChannelsInput append channelIDs to a user's list to autohost.
- AddBrowserPushSubscriptionPayload
- AddChannelBlockedTermInputAddChannelBlockedTermInput takes in the channel, phrases, and if the term should be editable by mods.
- AddChannelPermittedTermInputAddChannelPermittedTermInput takes in the channel, phrases, and if the term should be editable by mods.
- AddCollectionItemInputAddCollectionItemInput accepts a collectionID and item ID and parameters to add the item to a collection.
- AddCompetitionPhaseInputAdd a Phase to a Competition.
- AddCompetitionPlayerInputAdd a User as a player to a Competition.
- AddCompetitionTeamInputInputs adding a competition team to a competition.
- AddDeviceTokenInputAddDeviceTokenInput accepts a token and other parameters to add a device token to a given user.
- AddDeviceTokenPayloadThe response from adding a push notification token to a user.
- AddDropToCampaignInputAddDropToCampaignInput has fields required to create a drop within a campaign.
- AddEditorInputAddEditorInput contains the parameters to add an editor.
- AddRadioRecentlyPlayedInputAddRadioRecentlyPlayedInput contains the parameters to register a play start.
- AddReactionInput
- AddRecommendationFeedbackInputData required to add recommendation feedback.
- AddStreamAuthorizedUserInputAddStreamAuthorizedUserInput contains the channelID for the broadcaster and the authorized userID.
- AdPollVoteA vote an ad poll and associated information.
- AdRequestContextThe context of an upcoming ad request.
- AdRequestPlayerContextThe context of the Player when the ad request is about to be made.
- AdSessionAdSession is the response object from an Ad Request.
- AllocateKeysForBountyInputInput required to allocate keys for the bounty.
- AllowRejectedChatMessageInput
- AllowRejectedCheerInputInput to the allowRejectedCheer mutation.
- AllowRejectedCheerPayloadPayload from the allowRejectedCheer mutation.
- AndroidPaymentTrackingDataInputAndroidPaymentTrackingDataInput contains fields to pass in tracking data.
- AnimatedImageAssetAn animated image asset.
- ApplyExtensionActivationsInputA mapping of extension type to list of activation configs.
- ApproveUnbanRequestInputRequired input to approve an unban request on a channel.
- ArchiveChanletInputArchiveChanletInput archives a chanlet by chanlet ID.
- ArchiveCommunityPointsCommunityGoalInputArchive community goal input.
- ArchivePollInChannelInputInputs for archiving a poll.
- ArchivePollInputInputs for archiving a poll.
- AssignEmoteToBitsTierInputThe input for assign emote to bits tier.
- AssignEmoteToSubscriptionProductInputThe input for assign emote to subscription product.
- AssignExtensionBillingManagerInputInputs to the SetExtensionBillingManager mutation.
- AssociatesStoreInformation regarding an Amazon Associates store.
- AuthenticatedSessionAuthenticated Twitch session.
- AutoModCaughtMessageA message rejected by automod.
- AutoModContentAutomodContent is the automod response for the text evaulated.
- AutoModContentInputAutoModContentInput is the input of query AutoModContent.
- AutoRefillProfileAuto Refill profile information.
- BackupStreamSessionBackupStreamSession identifies the backup stream session.
- BadgeCommunicates a user's status in chat.
- BanUserFromChatRoomInput
- BanVideoCommenterInput
- BeginUseBitsInExtensionInputThe required input for an BeginUseBitsInExtension mutation.
- BeginUseBitsInExtensionPayloadThe result of a BeginUseBitsInExtension mutation.
- BillingAuthInfoBillingAuthInfo holds data to facilitate the Fraud analysis.
- BitsAdOfferBitsAdOffer is an offer to earn bits by watching an ad or interacting with an engagement.
- BitsBadgeTierNotificationA notification about achieving a new bits badge tier. Used to send a special message.
- BitsBundleOfferBitsBundleOffer is an offer to purchase a number of bits for a certain price.
- BitsChallengeConditionPoolRecipientWeightedShareBitsChallengeConditionPoolRecipientWeightedShare represents the weighted share of the total bits pool that a recipient user is entitled to upon condition satisfaction.
- BitsEventAn event that captures a single bits transaction.
- BitsHashtagEntryBitsHashtagEntry contains information about a hashtag, sucn as the description and image URL for display.
- BitsKeyCodeThe Bits Key Code that can be claimed to add bits to a user's account.
- BitsKeyCodeSelfClaimEdgeUser edge relating the key's status to the user.
- BitsLeaderboardBitsLeaderboard contains the leaderboard for a specified channel.
- BitsLeaderboardEntryLeaderboard entry at a specific node in a leaderboard connection.
- BitsLeaderboardItemLeaderboard item at a specific node in a leaderboard connection.
- BitsOfferBitsOffer is a way to obtain more bits.
- BitsProductA product for bits that contains all information about a product, except for the pricing.
- BitsProductPromotionPromotional information about bits products.
- BitsPromotion
- BlizzardUserInformation regarding a Blizzard account that is linked to Twitch.
- BlockUserInput
- BountyA bounty is a task that a user can complete for a payout.
- BountyCampaignA campaign defines the requirements and parameters for a set of bounties.
- BroadcastA historical representation of a live stream.
- BroadcastSettingsSettings for a User's broadcast that persist between streams.
- BulkApproveUnbanRequestInputRequired input to bulk approve a list of unban requests on a channel.
- BulkDenyUnbanRequestInputRequired input to deny a list of unban requests on a channel.
- CampaignA visible campaign on a given user's channel.
- CampaignObjectiveThis type holds information about a campaign objective, which belongs to a campaign. An objective can hold multiple milestones which users can hit and get rewards. An objective can hold a cheer group.
- CampaignTriggerThis type holds information about a campaign trigger, which belongs to a campaign. A trigger has a list of rewards that can be earned by various one time events.
- CancelActiveBoostOrdersInputThe required input for a cancelActiveBoostOrdersInput mutation.
- CancelBountyInputCancelBountyInput includes the bounty a user is trying to cancel.
- CancelFriendRequestInput
- CancelPayoutOnboardingWorkflowInputCancelPayoutOnboardingWorkflowInput returns the required input when starting a new workflow for payout onboarding.
- CancelPredictionEventInputInput for canceling a Prediction Event (and refunding all users who have contributed).
- CancelRaidInputInputs to the cancelRaid mutation.
- CancelSubscriptionGiftInputInputs for the mutation. Gift to be canceled by productID and originID.
- CancelUnbanRequestInputRequired input to cancel an unban request.
- CelebrationCelebration is a configuration that denotes when a celebration is triggerd and when sort of celebration will show when it triggers.
- CelebrationConfigThe channels configuration of celebrations.
- CelebrationProductA celebration product that a user may purchase.
- CelebrationProductBenefitA celebration product benefit the user will receive when purchasing the celebration product.
- CelebrationProductConfigInputConfiguration settings to change for a celebration product.
- ChallengeConditionA condition to be satisfied by a specific owner.
- ChallengeConditionParticipantA condition participant action that will be taken if an associated condition is satisfied.
- ChangelogEntryChangelogEntry is an entry that displays new items and notifications in the creator homepage changelog.
- ChangeUsernameInputInput for a change username.
- ChannelA User's place on Twitch.
- ChannelChallengeA challenge to which users can contribute bits.
- ChannelChallengeParticipantA participant contributing to a challenge and associated information.
- ChannelDashboardLayoutData about a single configured Mosaic layout. This layout specifies a configuration of panel dimensions and positions in a grid, as defined by the Mosaic algorithm.
- ChannelModerationActionEntryAn entry of a moderation action performed on a channel.
- ChannelModerationActionOnAutomodLevelEntryModeration Actions relating to automod levels. ex: automod level change.
- ChannelModerationActionOnAutomodTermEntryModeration Actions relating to automod terms. ex: add permitted term, remove permitted term, add banned term, remove banned term.
- ChannelModerationActionOnChannelEntryModeration Actions relating to another channel. ex: host, unhost, raid, unraid.
- ChannelModerationActionOnChatMessageEntryModeration Actions relating to chat messages. ex: delete message.
- ChannelModerationActionOnChatModeEntryModeration Actions realting to chat modes. ex: slow on, followers only on, emotes only, sub only, clear chat.
- ChannelModerationActionOnUnbanRequestsEntryModeration Actions relating to unban requests. ex: approve, deny.
- ChannelModerationActionOnUserEntryModeration Actions relating to a user. ex: ban, unban, timeout, untimeout, mod, unmod, vip, unvip.
- ChannelModerationActionOtherEntryModeration Actions that are unused, invalid or deprecated.
- ChannelRestrictionA restriction for a specific channel.
- ChannelViewerChannel/Viewer pair.
- ChargeInstrumentInformation about the intended device for making a refill purchase for a user.
- ChargeInstrumentInputInput charge instrument information.
- CheckoutConfigurationConfigs that help initiate the bits checkout flow.
- CheckoutConfigurationInputInputs for checkoutConfiguration.
- CheckoutPriceSummaryPrice information about an item in the checkout process.
- CheerInfoCheerInfo is the channel-specific bits/cheer settings and current state.
- CheermoteCheermote is the metadata about different variations of a single cheermote that can be use to cheer in this channel.
- CheermoteCampaignA campaign that is in association with a cheermote. Like, Old Spice could have a cheermote with Terry Crew's head that they will sponsor X Bits that get added on to cheers that use their cheermote.
- CheermoteCampaignSelfEdgeEdge that relates a cheermote campaign to the logged in user.
- CheermoteCampaignThresholdThreshold for sponsored cheermote campaign matching.
- CheermoteImageCheermoteImage is a single image variation of a `CheermoteTier`.
- CheermoteTierCheermoteTier has information about a single tier of a cheermote.
- CheerPartnerSettingsCheer settings, configured in their partner dashboard.
- CheerSettingsCheerSettings are the channel-specific cheer settings.
- ClaimableAn interface to represent a claimable thing.
- ClaimBountyInputClaimBountyInput includes the bounty a user is trying to claim.
- ClaimCommunityPointsInputInput for claiming community points.
- ClaimDropRewardsInputClaimDropRewardsInput has fields required to claim a drop.
- ClaimDropRewardsPayloadClaimDropRewardsPayload returns the state of the claim.
- ClaimPrimeOfferInput
- ClientAuthorizationThe authorization a user has provided to an OAuth client.
- ClipA recorded, replayable part of a live broadcast.
- CloneExtensionDiscoveryDataInputCloneExtensionDiscoveryData copies a given version's discovery data to another version.
- CloneExtensionManifestInputCloneExtensionManifest copies the data in a given extension version to a new version.
- CloudBroadcastRepresents a cloud broadcast and its state.
- CloudBroadcastProviderA cloud broadcast provider id.
- CloudBroadcastProviderCapabilitiesCapabilities of a cloud broadcast provider.
- CloudBroadcastProviderKeyA cloud broadcast provider id.
- CollectionCollection (a.k.a. Playlist) is a backend concept for a list of videos.
- CollectionsOptionsOptions for filtering collections.
- CommunityPointsAutomaticRewardAn automatic community points reward.
- CommunityPointsChannelEarningSettingsInformation on how points are earned by viewers in a specific channel.
- CommunityPointsChannelSettingsSettings for a channel's Community Points.
- CommunityPointsClaimPoints that are available for a user to click to claim in a channel.
- CommunityPointsCommunityGoalCommunity goal.
- CommunityPointsCustomRewardA custom community points reward on a channel.
- CommunityPointsCustomRewardRedemptionA community points custom reward that has been redeemed in a channel.
- CommunityPointsCustomRewardTemplateA template used to create a custom reward.
- CommunityPointsEmoteA community points emote.
- CommunityPointsEmoteModificationA community points emote modification.
- CommunityPointsEmoteModifierA community points emote modifier.
- CommunityPointsEmoteVariantA community points emote variant, includes base emote plus modifications.
- CommunityPointsImageUploadInfoThe information required for the client to upload an image for Community Points.
- CommunityPointsLastViewedContentByTypeAndIDHolds the last time a specific piece of content was viewed.
- CommunityPointsLimitedEarningsAvailability of limited earn actions for a viewer in a specific channel.
- CommunityPointsRedemptionQueueOptionsOptional filters that can be applied to a redemption queue query.
- CommunityPointsUpdateCustomRewardRedemptionStatusesProgressThe type representing Community Points Update Custom Reward Redemption Statuses Progress.
- CompanyA company that is on Twitch.
- CompetitionA Competition created by a competition organizer.
- CompetitionImageUploadIdentifiers for the competition image.
- CompetitionLobbyA Lobby in a phase.
- CompetitionLobbyParticipantA CompetitionLobbyParticipant, and its scores, in a lobby.
- CompetitionPhaseA Phase created by a competition organizer.
- CompetitionPlayerA player is solo participant in a Competition.
- CompetitionTeamA Team is scheduled or has competed in a Competition.
- ConnectAdIdentityInputConnectAdIdentityInput accepts a deviceID and other parameters to generate an ad identity for that user.
- ConsentThe consent status returned for the current user.
- ContributeCommunityPointsCommunityGoalInputContribute community goal input.
- ContributeToChallengeInputInputs for contributing to a challenge.
- CreateBadgeFlairInputInput to the CreateBadgeFlair mutation
- CreateBitsChallengeConditionForExtensionInputCreateBitsChallengeConditionForExtensionInput creates a Bits condition on behalf of a user by an extension.
- CreateBitsChallengeConditionParticipantForExtensionInputCreateBitsChallengeConditionParticipantForExtensionInput creates a Bits condition participant on behalf of a user by an extension.
- CreateBountyCampaignInputCreateBountyCampaignInput includes the campaign that is being created.
- CreateBountyCampaignUploadConfigInputCreateBountyCampaignUploadConfigInput is the input for create bounty campaign upload configuration.
- CreateBountyCampaignUploadConfigPayloadReturned information about image upload including URL to upload the image to.
- CreateCelebrationInputInputs for creating a new celebration.
- CreateChanletInputCreateChanletInput creates a chanlet under the given channelID.
- CreateChanletPayloadCreateChanletPayload returns the new chanlet that was created.
- CreateClipInputCreateClipInput creates a clip either from a broadcast or video. If both broadcastID and videoID are set, the broadcastID will be preferred.
- CreateCollectionInputInputs for creating a new collection.
- CreateCommunityPointsCommunityGoalInputCreate community goal input.
- CreateCommunityPointsCustomRewardInputInput for creating a custom Community Points reward in a channel.
- CreateCommunityPointsImageUploadInfoInputInput for generating upload info (urls and upload IDs) for uploading Community Points images. Channel ID is required. Only one of the other three fields should be set, to indicate what the image is being uploaded for.
- CreateCompetitionInputCreate a Competition.
- CreateContentTagsInputCreate new tags associated with CLIP, STREAM, or VOD with contentID.
- CreateDashboardViewMosaicLayoutInputInput parameters for creating a new custom mosaic layout, such as for Stream Manager, Twitch Studio, etc. Requires at least the type and id to be specified.
- CreateDropBenefitInputCreateDropBenefitInput has fields required to create a drop benefit.
- CreateDropCampaignInputCreateDropCampaignInput has the fields necessary to create a campaign for an RBAC organization.
- CreateDropImageUploadURLInputInformation needed to generate a URL to upload a drop image to.
- CreateDropImageUploadURLPayloadReturned information about image upload including URL to upload the image to.
- CreateExtensionClientInputCreateExtensionClientInput creates an extension with a given name.
- CreateExtensionImageUploadInfoInputInformation needed to generate a URL and UploadId to upload extension images to.
- CreateExtensionZipUploadInfoInputInformation needed to generate a URL and UploadId to upload extension zip file to.
- CreateFriendRequestInput
- CreateGameApplicationInputInput to the CreateGameApplication mutation.
- CreateGameBoxArtUploadURLInputGameID that needs to upload a box art image.
- CreateGameBoxArtUploadURLResponseURL info that can be used to upload the image.
- CreateLoyaltyBadgeInputCreateLoyaltyBadge creates a new badge with these settings.
- CreateLoyaltyBadgeUploadConfigInputCreateLoyaltyBadgeUploadConfig creates a config with URL to upload the badge image to.
- CreateModeratorCommentInputThe required input to create a moderator comment on a channel.
- CreateMultiVideoHighlightMetadataMetadata to describe the requested highlight to be created.
- CreateMultiviewContentAttributeImageUploadConfigInputContains the channel ID to create new image upload URL for.
- CreateMultiviewContentAttributeImageUploadConfigPayloadPayload contains the upload ID and URL, as well as the URL to access the uploaded image.
- CreateOrganizationApplicationInputInput to the CreateOrganizationApplication mutation.
- CreateOrganizationApplicationPayloadOutput from the CreateGameApplication mutation.
- CreateOrganizationInviteInputInputs to the CreateOrganizationInvite mutation.
- CreateOrganizationJWTInputInputs to the CreateOrganizationJWT mutation.
- CreateOrganizationMemberInputInputs to the CreateOrganizationMember mutation.
- CreatePanelImageUploadInfoThe upload info struct that is returned from AWS.
- CreatePanelImageUploadInfoInputInformation required to generate a URL to upload a panel image to.
- CreatePanelInputCreatePanelInput contains a panel with created data The schema here has arguments for both extension panels and default panels each panel needs a PanelType, and channelID it corresponds to, but each panel does not need the other arguments extension panels can have a slotID default panels can have a title, image, link, and/or description.
- CreatePollInputInputs for creating a new poll.
- CreatePostInput
- CreatePredictionEventInputInput for creating a Prediction Event.
- CreateRaidInputInputs to the createRaid mutation.
- CreateRewardedVideoTokenInputInputs to the createRewardedVideo mutation.
- CreateScheduleInputThe input to create a schedule.
- CreateScheduleSegmentInputThe input to create a new schedule segment.
- CreateSocialMediaInputCreateSocialMediaInput creates social media under the given channelID.
- CreateSquadStreamInvitationInputInputs to the createSquadStreamInvitation mutation.
- CreateStuccoInputInputs to creating a stucco.
- CreateStuccoPackInputInputs for creating a new stucco pack.
- CreateStuccoPackItemInputSingle item in a stuccopack, as part of the create stucco pack call, representing one stucco to be used in a certain slot.
- CreateUnbanRequestInputRequired input to create an unban request on a channel.
- CreateVideoAppealInputCreateVideoAppealInput details needed to create a video appeal.
- CreateVideoAppealPayloadCreateVideoAppealPayload the ID of the video for the appeal made.
- CreateVideoBookmarkInputInput for creating a new bookmark.
- CreateVideoCommentInput
- CreateVideoHighlightInput
- CreateVideoHighlightMetadata
- CreateVideoThumbnailUploadRequestInputInput to CreateVideoThumbnailUploadRequest mutation.
- CreatorCampArticleA CreatorCampArticle is a represenation of an article from https://www.twitch.tv/creatorcamp.
- CreatorCampCategoryA CreatorCampCategory is a grouping of CreatorCamp articles. https://www.twitch.tv/creatorcamp.
- CreatorGiftingThe container for creator gifts the creator has. This will be null if the creator does not have this feature enabled.
- CreatorHomeTop level Creator Home object, includes data for clusters and panels.
- CreatorHomeClusterPredefined clusters for creators.
- CreatorOnboardingContentOnboarding content and tips that are shown during the streamer onboarding experience.
- CreatorReferralLinkA url to be shared by a creator to gain referrals, and associated metadata.
- DashboardActivityFeedActivityAn action (and metadata about the action) which occurred for a channel's Dashboard Activity Feed.
- DashboardActivityFeedActivityAutoHostingWhen a user AutoHosts a channel.
- DashboardActivityFeedActivityBitsUsageWhen a user uses Bits for or sends Bits to a channel.
- DashboardActivityFeedActivityBoostCompleteWhen a Boost completes for the given user.
- DashboardActivityFeedActivityBoostStartWhen a Boost starts for the given user.
- DashboardActivityFeedActivityCelebrationPurchaseEventWhen a Celebration event occurs for the given user.
- DashboardActivityFeedActivityCommunityPointsRewardWhen a user redeems a community points reward on a channel.
- DashboardActivityFeedActivityCommunitySubscriptionGiftingWhen a user gifts subscriptions to a community for a channel.
- DashboardActivityFeedActivityCopoGoalEndWhen a Community Goal ends for the channel.
- DashboardActivityFeedActivityDropClaimWindowOpenWhen a creator completes a drop quest and a drop can now be claimed by users/viewers.
- DashboardActivityFeedActivityFollowingWhen a user newly follows or refollows a channel.
- DashboardActivityFeedActivityHostingWhen a user hosts a channel.
- DashboardActivityFeedActivityHypeTrainEventWhen a HypeTrain event occurs for the given user.
- DashboardActivityFeedActivityIndividualSubscriptionGiftingWhen a user gifts a single subscription to another individual user for a channel.
- DashboardActivityFeedActivityIngestSessionStartingWhen an ingest session begins. Deprecated type: no longer exists in activity feed.
- DashboardActivityFeedActivityPrimeResubscribingWhen a user resubscribes via Twitch Prime to a channel.
- DashboardActivityFeedActivityPrimeSubscribingWhen a user subscribes for the first time via Twitch Prime to a channel.
- DashboardActivityFeedActivityRaidingWhen a user raids a channel.
- DashboardActivityFeedActivityResubscribingWhen a user resubscribes (NOT via Twitch Prime) to a channel.
- DashboardActivityFeedActivitySubscribingWhen a user subscribes for the first time (NOT via Twitch Prime) to a channel.
- DeactivateExtensionInputThe required input for a deactivateExtension mutation.
- DeclineOrganizationInviteInputInput to the DeclineOrganiztaionInvite mutation.
- DefaultPanelDefaultPanel is the normal panel type that displays text and images.
- DeleteAllChannelVideosInputInputs for deleting all videos by channel id mutation.
- DeleteBitsBadgeTierEmoticonInputThe input for delete bits badge tier emoticon.
- DeleteCelebrationInputInputs for deleting a celebration.
- DeleteChannelBlockedTermInputInputs for the mutation. channel ID and a list of phrases to be deleted.
- DeleteChannelClipsInputInputs for the deleting a channel's clip.
- DeleteChannelClipsPayloadThe returned payload from the mutation.
- DeleteChannelPermittedTermInputInputs for the mutation. channel ID and a list of phrases to be deleted.
- DeleteChatMessageInputThe input for deleteChatMessage.
- DeleteCheermoteTierInputThe input for delete cheermote tier.
- DeleteClipsInputDeleteClipsInput accepts either a list of slugs, a video id, or a broadcast id to determine the clips to delete.
- DeleteCollectionInputDeleteCollectionInput accepts a collection ID to delete a collection.
- DeleteCommunityPointsCommunityGoalInputDelete community goal input.
- DeleteCommunityPointsCustomRewardInputInput for deleting a custom Community Points reward in a channel.
- DeleteCompetitionInputDelete a Competition.
- DeleteContentTagsInputDelete tags associated with CLIP, STREAM, or VOD with contentID.
- DeleteDefaultPaymentMethodInputThe input required when making a request to delete a user's default payment method for a given provider.
- DeleteDeviceTokenInputDeleteDeviceTokenInput accepts a token and user ID and deletes that pair from the database.
- DeleteDeviceTokenPayloadThe response from deleting a push notification token from a user.
- DeletedMessageA deleted message sent by a user to a stream chat.
- DeleteDropCampaignInputDeleteDropCampaignInput has fields required to delete a campaign.
- DeleteDropInputDeleteDropInput has fields required to delete a drop.
- DeleteEmoteInputThe input for delete emote.
- DeleteExtensionImageInputInformation needed to delete images on extension.
- DeleteExtensionInputInputs for the deleteExtension mutation.
- DeleteExtensionSecretsInputThe information we need to delete the extension's secrets.
- DeleteLoyaltyBadgeInputInputs for the mutation. Loyalty Badge to be deleted by channelID, badgeID, and channelTenureMethodID.
- DeleteModeratorCommentInputOutput from the DeleteModeratorComment mutation.
- DeleteMultiviewContentAttributesInputContains a list of IDs of content attributes that are to be deleted.
- DeleteNotificationInput
- DeletePanelInput
- DeletePostInput
- DeleteRecommendationFeedbackInputData required to delete recommendation feedback.
- DeleteRecommendationFeedbackPayloadReturns the created feedback item back to the client.
- DeleteRoomInput
- DeleteRoomMessageInput
- DeleteScheduleInputThe input to delete a schedule.
- DeleteScheduleSegmentInputThe input to delete a schedule segment.
- DeleteSocialMediaInputMutation input to delete a social media item by ID under the given channelID.
- DeleteSquadStreamInvitationInputInputs to the deleteSquadStreamInvitation mutation.
- DeleteStreamAuthorizedUserInputDeleteStreamAuthorizedUserInput contains the channelID for the broadcaster and the authorized userID.
- DeleteUserClipsInputInputs for the deleting clips made by user.
- DeleteUserClipsPayloadThe returned payload from the mutation.
- DeleteUserColorsInputInputs for the DeleteUserColors mutation.
- DeleteVideosInputInputs for the deleting videos by id mutation.
- DeleteVideoThumbnailInputInput information for deleting a thumbnail from a video.
- DenyRejectedChatMessageInput
- DenyRejectedCheerInputInput to the denyRejectedCheer mutation.
- DenyRejectedCheerPayloadPayload from the denyRejectedCheer mutation.
- DenyUnbanRequestInputRequired input to deny an unban request on a channel.
- DeselectChannelBadgeInputInputs for deselecting a channel badge.
- DirectoryA Directory is a container of content – Streams, Videos, and Clips – on Twitch.
- DisableTwoFactorInputThe required input for a disableTwoFactor mutation.
- DisableUserAccountInputInputs to the disableUserAccount mutation.
- DismissFriendRecommendationInput
- DismissRitualTokenInputDismissRitualTokenInput is the input when dismissing a ritual token.
- DismissVideoSuggestedHighlightInputInput for dismissing a video's suggested highlight.
- DropContains all of the information about a Drop awarded to a user.
- DropAccountLinkA mapping of the client ID set to determine whether a user has set up account linking for the game.
- DropActionContains all of the information about a Drop's action stating what happens when a drop is triggered. //To be deprecated.
- DropBenefitContains all of the information about a Drop awarded to a user.
- DropCampaignA campaign a developer is running to give drops away to viewers of their game To be considered live, a campaign must be enabled with the current time being after the start but before the end times To apply to a particular channel a campaign must be live and additionally the channel must be playing an applicable game and either must be one of the applicable channels or the campaign must have an empty applicable channel list (where an empty list specifically means all channels are eligible).
- DropCurrentSessionThe drop that is closest to completing for the current user that is actively earning progress.
- DropEligibilityContains all of the information about a Drop awarded to a user.
- DropImageUploadInputDropImageUploadInput has the fields required to upload a drop's image asset.
- DropImageUploadPayloadSetDropCampaignStatusPayload returns the result of the creation/update.
- DropObjectContains all of the information about a Drop awardable to a user. // deprecated in favor of EventBasedDrop and TimeBasedDrop.
- DropPreconditionDropPrecondition is the tuple of DropID and the DropPreconditionID, which is the drop that must be attained first.
- DropRewardContains all of the information about a Drop awarded to a user.
- DropRuleContains all of the information about a Drop's rule stating what a broadcaster has to do to trigger a drop. //To be deprecated.
- DropTypeAn interface to handle shared Drop data. The `Drop` type is already in use (although deprecated) so we can't use that name.
- EditRoomMessageInput
- EmbeddedEmoteEmbeddedEmote is an encoding format used to describe an emote embedded in a string of text. Example: body = "hey KappaHD" from = 4 to = 10 "KappaHD" will be replaced with the KappaHD emote image.
- EmitCampaignDiscoveryEventInputEmitCampaignDiscoveryEventInput contains the campaign objective type of the event being emitted and the channelID from which this event is born.
- Emote
- EmoteImageAssetInputThe ID, Size and AssetType of a previously uploaded emote.
- EmoteImageUploadConfigurationRepresents the data needed to continue the upload of an emoticon image asset.
- EmoteModifierGroupInputA set of modifications to apply to a tier of emotes for a creator.
- EmoteOrderThe new order for the specified emote in a particular emote group.
- EmoteSetRepresents a group of emotes.
- EndorsedChannelEdgeElement in a list of endorsed channels.
- EndUseBitsInExtensionInputThe required input for an EndUseBitsInExtension mutation.
- EnhancedExperiencesClientEnhancedExperiencesClient is an OAuth app that is authorized to use the Enhanced Experiences (E2) API for game integrations.
- EquipHeroAssetsInputEquipHeroAssetsInput contains the parameters to equip assets on a hero.
- EventBasedDropDrop triggered by an in-game event.
- ExpiredSubscriptionData about an inactive subscription to a broadcaster.
- ExportVideoToYoutubeInputInput information for exporting a video to Youtube.
- ExtensionTwitch Extension.
- ExtensionActivationInputRepresents the action which should be taken on the provided installation ID. If no anchor configuration is provided, the installation will be deactivated.
- ExtensionCarouselAn extension carousel.
- ExtensionCarouselEntryAn extension carousel entry.
- ExtensionCategoryAn extension category.
- ExtensionChallengeConditionByIDInputParameters for filtering ChallengeConditionParticipants.
- ExtensionChallengeConditionParticipantsInputParameters for filtering ChallengeConditionParticipants.
- ExtensionChallengeConditionsInputParameters for filtering ChallengeConditions.
- ExtensionClientExtensionClient is the authorization component of an extension.
- ExtensionCommentExtensionComment contains the data for the comment of an extension review.
- ExtensionConfigurationThe hosted configuration for an extension that comes from config service.
- ExtensionDiscoveryManifestInputExtension metadata used for discovery.
- ExtensionDynamicManagementInputExtensionDynamicManagementInput represents the game ID and whether it is dynamically managed or not on an extension.
- ExtensionImageUploadResponseUrl and UploadId provided by Upload Service.
- ExtensionInstallationExtension Installation are models which contain an Extension and it's associated installation metadata.
- ExtensionLinkUserInputThe required input for an ExtensionLinkUser mutation.
- ExtensionManifestExtensionManifest is the data that represents an entire extension manfiest.
- ExtensionPanelExtensionPanel is a placeholder in the panel list for arbitrary iframed content.
- ExtensionRatingExtensionRating contains the information of a user's rating of a Twitch extension.
- ExtensionTokenThe user-specific token for an installed extension on a channel.
- ExtensionVersionDiscoveryManifestExtensionVersionDiscoveryManifest is the data that represents an extension discovery manifest.
- ExtensionWhitelistsWhitelists for restricting extension access and behavior.
- ExtensionWhitelistsInputExtensionWhitelistsInput contains whitelists for restricting extension access and behavior.
- ExtensionZipUploadResponseUrl and UploadId provided by Upload Service.
- FeaturedContentSectionFeaturedContentSections contain the a set of FeaturedItems that should be shown together in a particular section of Twitch apps.
- FeaturedItem
- FeedFeed is twitch's pulse product of content a user may enjoy.
- FinalizeCompetitionLobbyInputFinalizeCompetitionLobbyInput contains the inputs required to change a lobby's status to done.
- FlaggedTrackInformation about the flagged track of copyrighted music.
- FlaggedTrackAppealThe appeal information associated with the flagged track.
- FollowGameInput
- FollowUserInput
- GameA Game is often the subject of a Stream on Twitch.
- GameApplicationGameApplication is an application to associate a game with an organization.
- GameClipsInputFiltering criteria for paginated game clips results.
- GameEdgeContains information about a Game's relationship to a given page (connection), and the Game itself.
- GameOptionsOptional input to filter categories. Add any additional optional fields to this input.
- GameStreamOptionsOptional input to filter game specific streams. add additional optional fields to this input.
- GenerateAnimatedEmoteInputInput to the animateEmote mutation.
- GenerateAnimatedEmotePayloadPayload from the animateEmote mutation.
- GenerateExtensionRatingsCSVReportInputGenerateExtensionRatingsCSVInput takes an extensionID and some time range info for generating a CSV of extension ratings data for an extension developer. Authenticated on UserID via oauth token and OWL (via the ExtensionRatings backend).
- GenerateSecondFactorQRCodeInputThe required input for a generateSecondFactorQRCode mutation.
- GenerateSubscribersCSVPayloadGenerateSubscribersCSVPayload returns the channelID it currently generating a CSV for.
- GiftCardCodeGiftCardCode that can be claimed to add a monetary balance to a user's account.
- GiftCardCodeSelfClaimEdgeUser edge relating the pin's status to the user.
- GoRaidInputInputs to the goRaid mutation.
- GrantVIPInputGrantVIPInput contains the parameters to grant the VIP status to a user for a channel.
- HearthstoneMomentHeroThe hero that either the broadcaster or opponent played.
- HeroRepresents the user's Hero.
- HeroSkeletonRepresents a Hero skeleton.
- HighlightRangeInput to describe a single continuous time range of the source VOD to be included in the highlight.
- HistoricalCompetitionLobbyAn minimal version of a DONE CompetitionLobby focusing on the outcome of a lobby
- HostTargetChannelInputHostTargetChannelInput contains the necessary inputs to host a target channel.
- HypeTrainBadgeRewardThe Hype Train reward that's a Badge.
- HypeTrainConfigThe Hype Train config for a channel.
- HypeTrainEmoteRewardThe Hype Train reward that's an Emote.
- HypeTrainExecutionThe structure that defines Hype Train Execution in a channel.
- HypeTrainLevelThe Hype Train level configuration, which includes information about level completion and associated rewards.
- HypeTrainRewardThe hype train reward interface, which has to implement an identifier and the hype train reward type.
- InstallExtensionErrorInstallExtensionError is wrapper for error associated with the installExtension mutation.
- InstallExtensionInputThe required input for an installExtension mutation.
- InternalChargeModelInternalChargeModel defines a 1P price identifier for the offer.
- InterruptScheduleInputThe input to interrupt a schedule.
- InvalidateAuthenticatedSessionsInputArguments for the invalidation of all of a user's sessions.
- InvalidateEmailAssociationInputInvalidateEmailAssociationPayload is input required to mark a user as not owning an email address.
- IOSPaymentTrackingDataInputIOSPaymentTrackingDataInput contains fields to pass in tracking data related to iOS payments.
- IOSReceiptDataInputIOSReceiptDataInput contains the necessary fields to pass in iOS purchase receipt data.
- JoinChannelRoomsInput
- JoinRaidInputInputs to the joinRaid mutation.
- JoinRaidPayloadOutputs from the joinRaid mutation.
- KeyBatchNodeThe information associated with a given key batch.
- KeyPoolNodeThe information associated with a given key pool.
- LeaveChannelRoomsInput
- LeaveRaidInputInputs to the leaveRaid mutation.
- LeaveRaidPayloadOutputs from the leaveRaid mutation.
- LeaveSquadStreamInputInputs to the leaveSquadStream mutation.
- LockPredictionEventInputInput for moving a Prediction Event from ACTIVE to LOCKED, so that users can no longer make predictions on it.
- LoyaltyBadgeCommunicates a Loyalty Badge (usually during upload).
- LoyaltyBadgeUploadConfigLoyaltyBadgeUploadConfig is the upload configuration for creating loyalty badges.
- MakePredictionInputInput for making a Prediction.
- ManualChannelChallengeA custom challenge created by the broadcaster.
- ManuallyTriggerDropInputManuallyTriggerDrop has fields required to update a campaign summary.
- ManualTriggerBasedDropDrop manually triggered.
- MarkAllCreatorNotificationsAsReadInputInput for readAllCreatorNotifications mutation.
- MarkAllViewerNotificationsAsReadInputInput for readAllViewerNotifications mutation.
- MessageA message from a user.
- MilestoneMilestone is a construct is used within a tournament. For a given threshold, when the user cheers at or past this amount, they are able to claim a reward for cheering at this level. Rewards can be fulfilled by different platforms. Types of milestones: - **Global milestone**: for a given threshold, this milestone is reached when cheers from all users on the channel is greater than or equal to the threshold. This unlocks a reward for all users who have cheered. - **Individual milestone**: for a given threshold, this milestone is reached when an individual user's total cheers in the channel is greater than or equal to the threshold. This unlocks a reward for the individual user who cheered. - **Team milestone**: for a given threshold, this milestone is reached when an individual cheers for a specific team in total is greater than or equal to the threshold. This unlocks a reward for the individual user who cheered. NOTE: Should have been named CheeringTournamentMilestone.
- MobileAdIdentityInputMobileAdIdentityInput contains mobile device information.
- ModLogsAn interface to query subsets of the moderation logs information for a given channel.
- ModLogsCommentModLogsCommentsEntry defines an entry of a user's moderation history on a channel.
- ModLogsMessageA message sent from a user to a room.
- ModLogsTargetedModActionsEntryModLogsTargetedModActionsEntry defines an entry of a user's moderation history on a channel.
- ModUserInputModUserInput contains the parameters to add a user as a moderator to a channel.
- ModViewNewsfeedEntryModViewNewsfeedEntry is an entry that displays content for the Mod View page's "What's New" feed.
- MultiplayerAdOfferA multiplayer ad offer is an ad offer.
- MultiviewContentAttributeMulti-view content attribute(s) are used to augment the multi-view experience. they are used for filterings and groupings of chanlets to help viewers find content that they are interested in.
- MultiviewContentAttributeParamsContains all information to create a new content attribute.
- MutationOperations to update data in the Twitch API.
- OAuthAppInformation about a registered developer OAuth application.
- OfferOffer describes something that is purchasable.
- OfferAndStatusContains an offer ID and offer status.
- OfferPromotionPromotion is a modifier to an Offer.
- OnboardingCurrent state of the user in the onboarding process.
- OnsiteNotification
- OnsiteNotificationAction
- OrderPanelsInput
- OrganizationA developer organization.
- OrganizationInviteAn invitation to join a developer organization under a given role.
- OrganizationMemberA RBAC user.
- OverwatchLeagueTeamPreferenceContains Overwatch League Team preferences.
- OverwatchTeamPreferenceOptionContains an Overwatch team option to choose as the preferred team.
- PaidUpgradeData about a paid upgrade for a subscription. ie. a user upgrades a 1-month gift to a recurring subscription.
- PanelPanel is information about a single info panel for a channel.
- PartnershipApplicationPartnershipApplication is a submitted partnership application.
- PaymentMethodType of payment method a user has used to buy products on Twitch, such as subs.
- PaymentSessionInputs for PaymentSession.
- PaymentTransactionThere are legacy and new data sources that contain similar payment transaction data. This type aims to merge several data sources into one to expose a consistent payment history for each Twitch user.
- PaymentTransactionConnectionCriteriaInputFilter and sorting options for querying all transactions for a Twitch purchaser.
- PayoutInvitePayoutInvite describes a user's invite to a payout program.
- PayoutOnboardingWorkflowPayoutOnboardingWorkflow describes the workflow details while a user is onboarding into a payout program.
- PayWithAmazonConfigs
- PendingSubscriptionData about a pending future subscription. ie. a user turns a 1-month gift into a recurring subscription.
- PersonalSectionChannelDescribes the personal channel for the current user.
- PollA poll users can vote in.
- PollChoiceA choice in a poll that users can vote for.
- PollSettingsPoll Settings.
- PollTokenBreakdownA breakdown of tokens used/by for this poll/choice/user.
- PollVoteBreakdownA breakdown of votes cast for/by this poll/choice/user.
- PollVoterA voter taking part in a poll and associated information.
- PollVoterChoiceA choice a voter made taking part in a poll.
- Post
- PredictionA single Prediction made by a user on a Prediction Event.
- PredictionEventAn Event that users can make Predictions on.
- PredictionOutcomeA single Outcome that users can choose in a Prediction Event.
- PremiereDEPRECATED.
- PresignDevInsightsReportURLInputInput for presignDevInsightsReportURL mutation.
- PriceInfoGeneric Price Information that supports taxing and multi region pricing. LONG-TERM NOTE: using Int (32 bit) as a price field can cause issue when we sell products locally e.g. 2147483648 (2^31) Lao Att = 253132 USD cent Therefor, if we sell product which price more than $2500 in Laos currency. We will need to fix this.
- PrimeOfferPrime Digital Content Offers are displayed to users on Twitch via Offers in the top nav.
- PrimeOfferWithEligibilityRepresents a Prime Gaming content offer with the requesting user's eligibility information. These offers are displayed on the Crown menu on Twitch.tv.
- PrimePromotionMetadata relevant to Prime copy or marketing that needs to be scheduled.
- PrimeSettingsPrime Settings related data for a given user.
- ProcessAndroidPaymentInputProcessAndroidPaymentInput contains the necessary fields to process an Android payment.
- ProcessIOSPaymentInputProcessIOSPaymentInput contains the necessary fields to process a payment from the iOS platform.
- ProductCatalogBenefitA benefit the user receives when purchasing a product from the product catalog.
- ProductCatalogItemA product appearing in the product catalog.
- PublishClipInputPublishClipInput edits the clip with the provided slug via segments.
- PublishCompetitionInputPublish a Competition.
- PublishSubscriptionEmoteInputThe data needed to finalize the creation of a Subscription Emote.
- PurchasableOfferParamsParameters to get details about a purchasable offer for the current logged in user.
- PurchaseOfferInputPurchaseOfferInput contains the necessary fields to purchase an offer.
- PurchaseOrderPurchaseOrder is the record of a purchase made by a user.
- PurchaseProfilePurchase profile of a recurring or non-recurring subscription that a user bought.
- QueryRoot fields to access the Twitch API.
- RadioTwitch Radio access.
- RadioAccountAmazon Music user information for a Twitch user using Twitch Radio.
- RadioAlbumA Twitch Radio Album.
- RadioArtistA Twitch Radio artist.
- RadioPlaylistA Twitch Radio playlist.
- RadioRecentlyPlayedContent recently played in the client.
- RadioStationA Twitch Radio station.
- RadioTrackA Twitch Radio track.
- RaidA raid represents a broadcaster directing their viewers to another channel in a synchronized "raid" on the channel after a countdown during which each viewer has a chance to opt out of the raid. Raids are created by a broadcaster from their dashbboard where they can search and select the channel they wish to target. Once selected the raid takes counts down to prepare after which the broadcaster can tell the raid to "Go", redirecting all joined raiders to the target channel.
- RateExtensionInputRateExtensionInput submits a user's rating and feedback on a Twitch extension.
- ReadNotificationsInput
- RecommendationFeedbackFeedback from a user about a piece of content.
- Recommendations
- RecommendedGamesConnectionThe response of a recommended games request which contains a list of recommended games.
- RecommendedGamesEdgeThe content to render from a recommended game.
- RecommendedStreamsConnectionThe response of a recommended streams request which contains a list of recommended streams.
- RecommendedStreamsEdgeThe content to render from a recommended stream.
- RecurringPaymentDetailPayment Method information for a recurring payment. An abstraction for a set of Payments models, existing here to surface to the Payments Management Page.
- RedeemCommunityPointsCustomRewardInputInput for redeeming a custom Community Points reward in a channel.
- RedeemRitualTokenInputRedeemRitualTokenInput is the input when redeeming a ritual token.
- RedeemSubscriptionInputRedeemSubscriptionInput creates a new subscription redemption input.
- RedeemTrueXAdInput
- RefreshExtensionTokenInputThe required input for an RefreshExtensionToken mutation.
- RegenerateStreamKeyInputRegenerateStreamKeyInput is input required to regenerate a broadcaster's stream key.
- RegisterPayoutInformationInputRegisterPayoutInformationInput is the input required to register a user's payout information during payout onboarding.
- RegisterTwoFactorConfirmationInputThe required input for a registerTwoFactorConfirmation mutation.
- RegisterTwoFactorInputThe required input for a registerTwoFactor mutation.
- RejectedChatMessage
- RejectFriendRequestInput
- RejectSquadStreamInvitationInputInputs to the rejectSquadStreamInvitation mutation.
- RejectSquadStreamOutOfNetworkInvitationsInputInputs to the rejectSquadStreamOutOfNetworkInvitations mutation.
- RemoveAutohostChannelsInputRemoveAutohostChannelsInput remove channelIDs from a user's list to autohost.
- RemoveCollectionItemInputRemoveCollectionItemInput accepts a collectionID and item ID and parameters to remove the item from a collection.
- RemoveCompetitionPhaseInputRemoveCompetitionPhaseInput contains the inputs required to remove a phase.
- RemoveCompetitionPlayerInputRemove a player from a Competition. If you remove a player that is part of a team, the player will removed from the team as well. If that player is a captain of the team, the team will no longer have a captain.
- RemoveCompetitionTeamInputInputs for removing a competition team from a competition.
- RemoveEditorInputRemoveEditorInput contains the parameters to revoke the editor status from a user for a channel.
- RemoveEmoteFromGroupInputThe input for remove emote from group.
- RemoveOrganizationMemberInputInputs to the removeOrganizationMember mutation.
- RemoveReactionInput
- RemoveSquadStreamMemberInputInputs to the removeSquadStreamMember mutation.
- RemoveStuccoInputInputs for removing a stucco (from the library). - Active stuccos cannot be removed, they have to be inactive first (not part of a stucco pack).
- ReorderCollectionItemInputReorderCollectionItemInput accepts a collectionID and item ID and parameters to update the item order of a collection.
- ReportContentInput
- ReportContentPayload
- ReportReasonA valid reason for a report.
- ReportWhisperInputInput to the reportWhisper mutation.
- ReportWhisperThreadInput
- RequestRitualTokenInputRequestRitualTokenInput is the input when requesting a ritual token.
- ResendVerificationEmailInputResendVerificationEmailInput is input required to resend the verification email.
- ResolvePredictionEventInputInput for resolving a Prediction Event (and paying out all of the users who predicted correctly).
- ResourceRestrictionA restriction for a specific resource.
- RespondToTeamInvitationInputInputs to the respondToTeamInvitation mutation.
- ResubNotificationA recent resub token to use for sending a special message.
- ResumeScheduleInputThe input to resume a schedule.
- RevenueConfigRevenue configuration data related to a subscription product.
- RevokeVIPInputRevokeVIPInput contains the parameters to revoke the VIP status of a user from a channel.
- RitualTokenA ritual is an opportunity for a viewer to better connect with a streamer's community by announcing when they reach milestones in the channel. A ritual token is issued when a user is eligible for the ritual, and can be redeemed to send the announcement in a channel.
- RoomDEPRECATED. A chatroom associated with a channel where members of the room can exchange messages.
- RoomMessageDEPRECATED A message sent from a user to a room.
- RotateExtensionSecretsInputRotateExtensionSecretsInput includes the necessary parameters for creating a new extension secrets.
- RunMultiplayerAdsInputInputs for running multiplayer ads.
- SaveExtensionDiscoveryManifestInputExtension metadata used for discovery.
- SaveExtensionManifestInputSaveExtensionManifestInput updates the manifest.
- SaveExtensionWhitelistsInputExtensionWhitelistsInput contains whitelists for restricting extension access and behavior.
- SCETitleSony Computer Entertainment (SCE) title properties. Used as part of stream metadata for PlayStation.
- SCEUserSony Computer Entertainment (SCE) user properties. Used as part of stream metadata for PlayStation.
- ScheduleThe channel schedule.
- ScheduleSegmentThe segment of a schedule.
- SearchForEdgeContains a single result item and a tracking ID.
- SearchForEdgeRelatedLiveChannelsContains a single result item and a tracking ID.
- SearchSuggestionA search suggestion.
- SearchSuggestionCategoryA category search suggestion.
- SearchSuggestionChannelA channel search suggestion.
- SearchSuggestionTrackingAn object containing tracking data for a search suggestion.
- SeedCompetitionParticipantInputInputs for seeding a competition participant.
- SelectChannelBadgeInputInputs for selecting a channel badge.
- SelectGlobalBadgeInputInputs for selecting a global badge.
- SelfClaimEdgeAn interface to represent the logged in user's relationship to the claimable.
- SendChatMessageThroughSubscriberModeInputInput for sending a chat message through subscriber-only mode with Channel Points.
- SendCheerInput
- SendCheerPayload
- SendExtensionMessageInputInput to the sendExtensionMessage mutation.
- SendHighlightedChatMessageInputInput for sending a highlighted chat message with Channel Points.
- SendRoomMessageInput
- SendWhisperInput
- SetAutoAdDensityInputSets the auto ad density for the channel.
- SetAutoAdDensityPayloadShows the newly updated values for autoad settings.
- SetAutohostChannelsInputSetAutohostChannelsInput sets the user's list to autohost.
- SetAutoRefillSettingsInputInput for setting auto refill settings.
- SetChannelNotificationSettingInput
- SetChannelTrailerInputInputs to the setChannelTrailer mutation.
- SetContentTagsInputUpdate tags associated with CLIP, STREAM, or VOD with contentID.
- SetCreatorBadgeFlairInputThe input to be provided to the SetCreatorBadgeFlair mutation.
- SetDashboardAlertQueueActivityStatusInputInputs to the SetDashboardAlertQueueActivityStatus mutation.
- SetDashboardAlertQueuePreferenceInputInputs to the SetDashboardAlertQueuePreference mutation. Only one of the boolean settings should be set at once.
- SetDefaultPaymentMethodInputThe input to be provided to the setDefaultPaymentMethod mutation.
- SetDropBenefitsOnDropInputSetDropBenefitsOnDropInput has fields required to update a drop's list of benefits.
- SetDropCampaignAccessInputSetDropCampaignAccessInput has fields required to update a campaign's access.
- SetDropCampaignStatusInputSetDropCampaignStatusInput has fields required to update a campaign's status.
- SetDropCampaignSummaryInputSetDropCampaignSummaryInput has fields required to update a campaign summary.
- SetDropEventRuleInputSetDropEventRuleInput has the fields required to set an event based rule on a drop.
- SetDropManualTriggerRuleInputSetDropManualTriggerRuleInput has the fields required to set a manual trigger based rule on a drop.
- SetDropSummaryInputSetDropSummaryInput has fields required to update a drop's summary.
- SetDropTimeBasedRuleInputSetDropTimeBasedRuleInput has fields required to update a drop's rule to a minutes watched based rule.
- SetExtensionConfigurationInputThe required input for a setExtensionConfiguration mutation.
- SetExtensionConfigurationPayloadSetExtensionConfiguration returns the Input as the extensions configuration endpoint returns a 204.
- SetExtensionFeatureFlagsErrorSetExtensionFeatureFlagsError is wrapper for error associated with the setExtensionFeatureFlags mutation.
- SetExtensionFeatureFlagsInputThe required input to set feature flags for an installation.
- SetExtensionInstallationOAuthInputThe required input to set oauth on an installation.
- SetGameDropAccountLinkClientInputSetGameDropAccountLinkClientInput has fields necessary to update a game's account link client ID used to verify a user has connected their in-game account.
- SetHeroAsAvatarInputSetHeroAsAvatarInput contains the parameters to copy the user's hero to their avatar. no parameters are required, because this mutation copies the requesting user's hero to the requesting user's avatar, but we're passing the heroID here because of a bug in the way `make check` works.
- SetModLogsAccessInputThe required input to set a role's moderator logs' access.
- SetOverwatchLeagueTeamPreferenceInputSetOverwatchLeagueTeamPreferenceInput contains the OverwatchLeagueTeamPreference ID to set.
- SetPreferredLanguageTagInputThe required input for a setPreferredLanguageTag mutation.
- SetRadioCurrentlyPlayingInputThe required input to set radio track information currently being played.
- SetResourceRestrictionInputSetResourceRestrictionInput sets a restriction for the given resourceID.
- SetScheduleReminderInputSetScheduleReminderInput has fields required to set a schedule event reminder.
- SetSquadStreamPrimaryPlayerInputInputs to the setSquadStreamPrimaryPlayer mutation.
- SetUnbanRequestsSettingsInputRequired input to set unban requests settings on a channel.
- SetUserResidenceInputSetUserResidenceInput is input required to set a user's residence.
- Share
- ShelfAn ordered list of content to render with metadata on the content.
- ShelfContentEdgeThe content to render in a shelf.
- ShelvesAvailableOptionsA set of options for configuring which shelf data to return to the user.
- ShortVideoA short video from a ShortVideoFeed and its relevant metadata.
- ShortVideoReactionAn aggregated counter for the contained emote to display how many reactions to a ShortVideo there have been.
- SmiliesSetWrapper around the standard emoticon groups for Prime Emoticons.
- SocialMediaA social media item that is an attribute of Channel.
- SpendSubscriptionCreditInputInput requires the broadcaster to be payed and user to deduct credit.
- SpendSubscriptionCreditPayloadMutated data after spending the subscription credit.
- SponsoredCheermoteChannelSettingsNodeThe information associated with a given sponsored cheermote channel setting.
- SquadStreamA squad stream represents a group of broadcasters that are streaming together. When a squad stream is live, viewers can opt to watch the streams of all its members together from a single view. Squad streams are created by a broadcaster who invites other broadcasters to participate. Each broadcaster who accepts an invitation becomes a member of the squad stream and can also invite other broadcasters to participate. At the moment, a squad stream can have up to four members and a broadcaster can only belong to a single squad stream. A squad stream ends when all its members leave or stop streaming.
- SquadStreamInvitationSquadStreamInvitation represents an invitation sent by a member of a squad stream to another user to join the squad stream.
- StartAdInputStartAdInput ...
- StartBountyInputStartBountyInput includes the bounty a user is trying to start.
- StartCloudBroadcastInputInput for remotely and asynchronously starting a cloud broadcast for the given channelID.
- StartPayoutOnboardingWorkflowInputStartPayoutOnboardingWorkflowInput returns the required input when starting a new workflow for payout onboarding.
- StartWatchPartyInputInput for starting a PV Watch Party.
- StopBountyInputStopBountyInput includes the bounty a user is trying to stop.
- StopCloudBroadcastInputInput for remotely stoping a Cloud broadcast for the given channelID.
- StopWatchPartyInputInput for stopping a PV Watch Party.
- StreamA live stream.
- StreamConnectionPaginated list of Streams.
- StreamEdgeContains information about a Streams's relationship to a given page (connection), and the Stream itself.
- StreamManagerMosaicLayoutMosaic layouts for Dashboard Stream Manager.
- StreamOptionsOptional inputs to filter streams add additional optional fields for filtering streams to the StreamOptions input type.
- StreamRecommendationEdgeThe content to render in a live recommendation item.
- StreamRecommendationsFiltersStreamRecommendationsFilters defines parameters which filter down stream recommendation results.
- StreamSummaryAnalytics information for a streaming session.
- StuccoA stucco (wide emote) represents an image that can be used for user interaction in specific cases.
- StuccoPackA Stucco pack is a collection of stuccos, the pack can be activated to be used by viewers of that channel.
- SubmitCSATFeedbackInputSubmitCSATFeedbackInput creates or updates a currently authenticated user's rating/feedback of Twitch Developer Products.
- SubmitCSATFeedbackResponseThe response of a successful submitCSATFeedback mutation.
- SubmitEmotePrefixInputSubmitEmotePrefix creates a new emoticon prefix for a channel.
- SubmitEmoticonPrefixInputSubmitEmoticonPrefix creates a new emoticon prefix for a channel.
- SubmitExtensionFeedbackInputSubmitExtensionFeedbackInput submits a user's feedback for a related rating on a Twitch extension.
- SubscriberBadgeProgressSubscriberBadgeProgress contains progress information for subscription badges based on a user's tenure.
- SubscriptionBenefitData about a user's subscription to a broadcaster.
- SubscriptionGiftingA parent field for grouping the different types of gift subscriptions.
- SubscriptionGiftOfferA gift offer that is available on a particular subscription based on gift type and platform.
- SubscriptionGiftPromotionThe promotion offer on a subscription gift offer.
- SubscriptionOfferSubscription pricing information.
- SubscriptionProductA subscription that is purchasable by users. Once purchased, the subscription entitles the user to use special emote sets on Twitch.
- SubscriptionProductSelfConnectionThe connection between the user and subscription product.
- SubscriptionSummarySimple summary of subscription product.
- SubscriptionTokenBundleProductA SubscriptionTokenBundleProduct can contain multiple Offers. ex) A Bundle of size 3 tokens, can have 3 other offers such as: - Normal offer: "Pay $16.99 for the bundle - Discounted, one-time buy offer: "Pay $14.99 for the bundle, but a one-time purchase only" - Bits: Use X amount of Bits to purchase this Bundle.
- SwapCompetitionLobbyParticipantInputThe individual swap participant input.
- SwapCompetitionLobbyParticipantsInputSwapCompetitionLobbyParticipantsInput exchanges the lobby placements of the two participants within the same phase.
- SyncGameOnDropCampaignInputSyncGameOnDropCampaignPayload contains the campaign ID that needs to be synced.
- TagTag(s) are used as a discovery and search mechanism for tagged content, including Streams, Clips, and VODs.
- TaxInterviewTaxInterview describes the information for a user's Amazon tax interview during payout onboarding.
- TeamTeam represents a Twitch Team. Teams are collections of streaming channels, and are owned by a Twitch user. Teams have landing pages, e.g. https://www.twitch.tv/team/clg.
- TerminatePollInChannelInputInputs for terminating a poll.
- TerminatePollInputInputs for terminating a poll.
- TimeBasedDropA drop triggered by accummulating minutes watched.
- TimeBasedDropSelfEdgeUser specific data associated with this drop.
- ToggleRitualsEnabledInput
- TournamentTournament is an object that contains all information about a tournament managed within Bits for a specific event tied to cheering. NOTE: Should have been named CheeringTournament.
- TournamentRewardType containing information about a Reward and claiming information.
- TournamentTeamTeam is a construct that contains metadata about a team participating in the tournament, as well as the milestones associated with cheering for them.
- TrackAppealRequestInputTrackAppealRequestInput the details needs about which track to appeal.
- TransitionExtensionStateInputTransitionExtesnsionManifest updates the state of an existing extension.
- TriggerResultA result of a try to trigger a drop on a channel.
- TrueXAdTrueXAd is descriptive information about an engagement that was show for bits. Used as input on the redeem trueXAd mutation.
- TwitchStudioMosaicLayoutMosaic layouts for Twitch Studio.
- UnacknowledgedSubscriptionEventUsed to provide info on the subscription events that might have happened in another device and not acknowledged in the current device.
- UnbanRequestA request from a channel-banned user to the channel moderators to be unbanned from the channel.
- UnbanRequestsOptionsOptional filters that can be applied to an unban requests query.
- UnbanUserFromChatRoomInput
- UnblockUserInput
- UndoRecommendationFeedbackInputData required to undo recommendation feedback.
- UndoRecommendationFeedbackPayloadReturns the created feedback item back to the client.
- UnfollowGameInputUnfollowGameInput contains just the game ID of the game to unfollow.
- UnfollowUserInput
- UnfriendUserInput
- UnhostInputUnhostInput contains the necessary inputs to unhost a channel.
- UninstallExtensionInputThe required input for an uninstallExtension mutation.
- UninstallExtensionPayloadThe resulting payload of an uninstallExtension mutation.
- UnlinkAmazonConnectionInputUnlinkAmazonConnectionInput represent the parameters necessary to unlink an amazon connection.
- UnlinkRiotConnectionInputUser ID input of the connection being deleted.
- UnlockChosenModifiedSubscriberEmoteInputInput for unlocking a chosen modified subscriber emote with Community Points.
- UnlockChosenSubscriberEmoteInputInput for unlocking a chosen subscriber emote with Community Points.
- UnlockRandomSubscriberEmoteInputInput for unlocking a random subscriber emote with Community Points.
- UnmodUserInputUnmodUserInput contains the parameters to remove a user as a moderator to a channel.
- UnsubscribeEmailInputInput to the unsubscribe mutation. One of "channel" or "type" fields must be provided.
- UpdateAdPropertiesInputInputs to the updateAdProperties mutation.
- UpdateAllChannelVideosViewabilityInputInputs for updating all videos viewability by channel id mutation.
- UpdateAutohostSettingsInputUpdateAutohostSettingsInput update a user's autohost settings.
- UpdateAutoModLevelsInputDefines AutoMod category level settings for a Channel, either overallLevel or detailedAutoModLevels should be non null.
- UpdateBitsBadgeTierNotificationInputUpdateBitsBadgeTierNotificationInput is the input required when updating a bits badge tier notification.
- UpdateBitsBadgeTiersInputSettings related to bits badges.
- UpdateBoostSettingsInputThe required input for a updateBoostSettings mutation.
- UpdateBroadcastSettingsInputThe required input for a updateBroadcastSettings mutation.
- UpdateCelebrationConfigInputInputs for updating the user's celebration config.
- UpdateCelebrationInputInputs for creating a new celebration.
- UpdateCelebrationProductConfigInputInputs for updating the user's celebration product config.
- UpdateChanletContentAttributesInputMutation input for updating chanlet content attributes.
- UpdateChannelClipsSettingInputThe required input for a updateChannelClipsSetting mutation.
- UpdateChannelHomePreferencesInputThe input to update a channel's category shelf content.
- UpdateChannelPredictionSettingsInputUpdate a channel's Prediction Settings. All fields other than channelID are nullable; only specify fields that you wish to update.
- UpdateCheermoteTierInputThe data needed to update or create a broadcaster's custom cheermotes for a given tier.
- UpdateCheerPartnerSettingsInputMutation input for updating Bits partner channel settings.
- UpdateCheerPartnerSettingsSponsoredCheermoteInputSettings related to sponsored cheermote campaigns.
- UpdateClipInputUpdateClipInput updates the title of the clip with the provided slug.
- UpdateClipViewCountInputUpdateClipViewCountInput increments the viewcount of the provided slug.
- UpdateCollectionInputUpdateCollectionInput accepts a collection ID and parameters to update a collection.
- UpdateCollectionThumbnailInputUpdateCollectionThumbnailInput accepts a item ID and item Type for the new collection's thumbnail.
- UpdateCommunityPointsAutomaticRewardInputInput for updating an automatic Community Points reward in a channel. Only the channelID and rewardType are required. All other fields are optional. Only set fields that are intended to be updated.
- UpdateCommunityPointsChannelSettingsInputInput for updating Community Points channel settings.. Only the channelID is required. All other fields are optional. Only set fields that are intended to be updated.
- UpdateCommunityPointsCommunityGoalInputUpdate community goal input.
- UpdateCommunityPointsCustomRewardInputInput for updating a custom Community Points reward in a channel. Only the channelID and rewardID are required. All other fields are optional. Only set fields that are intended to be updated.
- UpdateCommunityPointsCustomRewardRedemptionStatusesByChannelInputInput for acting on all Community Points redemptions for a channel.
- UpdateCommunityPointsCustomRewardRedemptionStatusesByRedemptionsInputInput for acting on the Community Points redemptions from the provided list.
- UpdateCommunityPointsCustomRewardRedemptionStatusesByRewardInputInput for acting on all Community Points redemptions for a reward.
- UpdateCommunityPointsCustomRewardRedemptionStatusInputInput for acting on a Community Points redemption.
- UpdateCommunityPointsLastViewedContentInputInput for updating the last viewed community points content timestamps on a channel. The global content that was viewed on the channel will also have the timestamps updated.
- UpdateCommunityPointsSmartCostsAcknowledgementsInputInput required for updating community points smart costs acknowledgements.
- UpdateCompetitionInputUpdate a Competition.
- UpdateCompetitionPlayerInputUpdate the state of a player in a Competition.
- UpdateCompetitionTeamInputUpdate a team in a Competition.
- UpdateConsentInputUpdateConsentInput updates or creates a consent status for a privacy law.
- UpdateContentTagsInputUpdate tags associated with CLIP, STREAM, or VOD with contentID.
- UpdateDashboardViewMosaicLayoutInputInput for updating properties of an existing Mosaic layout. Must specify the id of the layout, which is validated based on the current userID. Must also specify the type of the layout. Other fields are optional; only specified fields are updated, and undefined ones are left unchanged.
- UpdateDropBenefitInputUpdateDropBenefitInput has fields required to update a drop benefit.
- UpdateDropBenefitOnDropInputUpdateDropBenefitOnDropInput has fields required to update a drop's benefit.
- UpdateDropPreconditionsInputUpdateDropPreconditionsInput has fields required to update multiple drops and their precondition drop.
- UpdateDropsOptOutStatusInputThe required input for a updateDropsOptOutStatus mutation.
- UpdateDropsOptOutStatusPayloadThe result of a updateDropsOptOutStatus mutation.
- UpdateExtensionDiscoveryDataInputUpdateExtensionDiscoveryDataInput updates the discovery data of a given extension version.
- UpdateExtensionManifestInputUpdateExtensionManifestInput updates the manifest.
- UpdateHypeTrainConfigInputUpdateHypeTrainConfigInput takes series of optional config settings.
- UpdateLeaderboardSettingsInputMutation input for updating partner leaderboard settings.
- UpdateLiveUpNotificationInputThe required input for a updateLiveUpNotification mutation.
- UpdateLobbyParticipantScoreInputInputs for updating the score for the lobby participant, who is a competition player or competition team, in a competition.
- UpdateOnboardingSkippedChannelsInputUsed for mutating onboarding status.
- UpdateOrganizationMemberRoleInputInputs to the UpdateOrganizationMemberRole mutation.
- UpdateOwnerChanletAttributesInputUpdateOwnerChanletAttributesInput updates the owner chanlet attributes.
- UpdatePanelInput
- UpdatePhoneNumberConfirmationInputThe required input for a updatePhoneNumberConfirmation mutation.
- UpdatePhoneNumberInputThe required input for a updatePhoneNumber mutation.
- UpdatePrimeOfferStatusInputThe offer id you wish to update as well as the status for the update.
- UpdatePrimeSettingsInputUpdatePrimeSettingsInput contains boolean for setting the users preference on chat notifications, and the users preference on the emoticon set name to be selected.
- UpdateRaidSettingsInputUpdateRaidSettingsInput update a user's raid settings.
- UpdateRoomInput
- UpdateRoomModesInput
- UpdateRoomViewInput
- UpdateScheduleSegmentInputThe input to update a schedule segment.
- UpdateSeenCreatorOnboardingContentInputUpdates the list of streamer onboarding content that a user has seen.
- UpdateSocialMediaInputUpdateSocialMediaInput updates existing a social media item under the given channelID.
- UpdateSquadInvitePolicyInputThe required input for an updateSquadInvitePolicy mutation.
- UpdateSquadStreamInputInputs to the updateSquadStream mutation.
- UpdateStuccoInputInputs to updating a stucco.
- UpdateStuccoPackInputInputs for updating a stucco pack (exchanging stuccos contained in the pack).
- UpdateStuccoPackItemInputSingle item in a stuccopack, as part of the update stucco pack call, representing one stucco to be used in a certain slot.
- UpdateSubscriptionProductInputInputs to the updateSubscriptionProduct mutation.
- UpdateUserColorsInputThe required input for a UpdateUserColorsInput mutation.
- UpdateUserCreateDateHiddenInputThe required input for a updateUserCreateDateHidden mutation.
- UpdateUserEmailReusableInputThe required input for a updateUserEmailReuseable mutation.
- UpdateUserInputThe required input for a UpdateUser mutation.
- UpdateUserIsEmailRevertSuccessInputThe required input for a updateUserIsEmailRevertSuccess mutation.
- UpdateUserTeamMembershipInputInputs to the updateUserTeamMembership mutation.
- UpdateUserVideoShelvesInputInput information for updating a user's video shelves. Video shelves are added/removed and reordered based on the provided shelfOptions.
- UpdateUserViewedVideoInputInput information for updating a resume watching entry for a specified user and video.
- UpdateVideoCommentInput
- UpdateVideoInputInput information for updating a video.
- UpdateVideoStreamSettingsInputUpdateVideoStreamSettingsInput updates the broadcaster's stream settings such as stream delay length seconds or stream key.
- UpdateVideosViewabilityInputInputs for the updating videos by id mutation.
- UpdateWhisperThreadInput
- UploadCompetitionImageInputGenerates an image URL to upload to.
- UploadConfigIndividual upload config.
- UploadImage
- UseChatNotificationTokenInputUseChatNotificationTokenInput is the input required for the UseChatNotificationToken mutation.
- UserTwitch user.
- UserByAttributeExactly one of the identifiers must be specified.
- UserClipsInputFiltering criteria for paginated user clips results.
- UserDropRewardA list of Drops awarded to the user via Drops2.0.
- UserLeaderboardUserLeaderboard contains a leaderboard whose entries are Users.
- UserLeaderboardItemUserLeaderboardItem at a specific node in a leaderboard connection.
- UserRiotConnectionLinkThe edge between a User and a Youtube Connection.
- UserSelfBitsBadgeUserSelfBitsBadge contains the current user's badge tier in a channel and progress toward the next tier. NOTE: should probably have been named CurrentUserBitsBadge.
- UserSteamConnectionLinkThe edge between a User and a Steam connection.
- VerifyContactMethodInputVerifyContactMethodInput is input required to verify a user contact method in EVS by their opaque ID.
- VerifyOneTimePasswordInputThe required input for a VerifyOneTimePasswordInput mutation.
- VerticalDirectoryA container of content for a vertical grouped by shelves.
- VerticalShelfAn ordered list of content to render with metadata on the content.
- VerticalShelfGroupA grouping of one or more shelves.
- VerticalSubDirectoryA container of content for a vertical by category, grouped by shelves.
- VerticalSubDirectoryContentContextThe content context of a subdirectory.
- Video
- VideoBookmarkA video bookmark.
- VideoCommentComment on a video.
- VideoConnectionOptionsInputOptional input to filter videos. Add any additional optional fields to this input.
- VideoIngestSessionVideo Ingest Session Metadata for the current or past broadcasts.
- VideoMomentA video moment represents either a point in time, or a duration of time, during which structured metadata is present.
- VideoShelfA video shelf contains items (clips, videos) from a user to display on their videos page.
- VideoTopClipsInputFiltering criteria for paginated video top clips results.
- VisitStreamManagerInputInput for Visit Stream Manager.
- VisitStreamManagerPayloadPayload returned from Visit Stream Manager call.
- VoteInAdPollInputInputs for voting on an ad poll.
- VoteInPollByChoiceIndexInputInputs for voting on a poll by choice index. Poll id and choice id are retrieved from the backend, before sending the vote.
- VoteInPollInputInputs for voting on a poll.
- WatchPartyContains all information for Prime Video Watch Parties.
- WatchPartyItemContains all fields needed to render a watch party item.
- WatchPartyItemSearchOptionsOptions for querying for catalog items. These fields are mutually exclusive and parentID will take precedent if both are specified.
- WhisperMessageA message sent in a whisper thread.
- WhisperThreadA conversation between two users.
- ZuoraConfigs