OBJECT

Mutation

Operations to update data in the Twitch API.

link GraphQL Schema definition

1type Mutation {
2
3# acceptFriendRequest accepts a friend request from the target user to the
4# authenticated user, creating a new Friend relationship.
5acceptFriendRequest(input: AcceptFriendRequestInput!): AcceptFriendRequestPayload
6
7# AcceptOrganizationInvite accepts an invite to an organization and the user is
8# added as member to that organization.
9acceptOrganizationInvite(
10input: AcceptOrganizationInviteInput!
11): AcceptOrganizationInvitePayload
12
13# Accept program agreement during payout onboarding.
14acceptProgramAgreement(
15input: AcceptProgramAgreementInput!
16): AcceptProgramAgreementPayload
17
18# acceptSquadStreamInvitation allows a user that has recieved a squad stream
19# invitation to accept and join
20# the squad stream.
21acceptSquadStreamInvitation(
22input: AcceptSquadStreamInvitationInput!
23): AcceptSquadStreamInvitationPayload
24
25# Acknowledge the result of a Prediction. Only the user who made the Prediction
26# can acknowledge the result.
27# This should be triggered automatically when the result of a Prediction is
28# displayed on screen, either from a
29# User Notice or by viewing the Channel Points panel. Because this has the
30# potential to trigger a thundering herd, as
31# every participant in a Prediction Event will see the results at the same time,
32# clients should automatically jitter
33# this call by waiting a random duration between 0-60 seconds before making this
34# mutation.
35acknowledgePredictionResult(
36input: AcknowledgePredictionResultInput!
37): AcknowledgePredictionResultPayload
38
39# acknowledgeSubscriptionState allow to apply Acknowledged status to the provided
40# subscription.
41acknowledgeSubscriptionState(
42input: AcknowledgeSubscriptionStateInput!
43): AcknowledgeSubscriptionStatePayload
44
45# acknowledgeUnbanRequest allows a user to acknowledge their unban request has
46# been approved, and can now
47# rejoin a channel's chat after being unbanned.
48acknowledgeUnbanRequest(
49input: AcknowledgeUnbanRequestInput!
50): AcknowledgeUnbanRequestPayload
51
52# Activate an extension which has been installed on a channel.
53activateExtension(
54input: ActivateExtensionInput!
55): ActivateExtensionPayload @deprecated( reason: "Should use applyExtensionActivations instead" )
56
57# Adds to a user's list of channelIDs to autohost.
58addAutohostChannels(input: AddAutohostChannelsInput!): AddAutohostChannelsPayload
59
60# addBrowserPushSubscription adds a browser push subscription for receiving
61# browser (desktop) push notifications.
62# The client must retrieve the input fields from the browser's push notification
63# API. Client's will
64# call this when the user opts-in. A browser push subscription is tied to a user's
65# browser (device).
66# Twitch will use these push subscriptions to send browser push notifications.
67#
68# Spec: https://www.w3.org/TR/push-api/#push-subscription.
69addBrowserPushSubscription(
70input: AddBrowserPushSubscriptionInput!
71): AddBrowserPushSubscriptionPayload
72
73# Adds a blocked term to a channel.
74addChannelBlockedTerm(input: AddChannelBlockedTermInput!): AddChannelBlockedTermPayload
75
76# Adds a permitted term to a channel.
77addChannelPermittedTerm(
78input: AddChannelPermittedTermInput!
79): AddChannelPermittedTermPayload
80
81# addCollectionItem adds an item to a collection.
82addCollectionItem(input: AddCollectionItemInput!): AddCollectionItemPayload
83
84# Add CompetitionPhase to a competition.
85addCompetitionPhase(input: AddCompetitionPhaseInput!): AddCompetitionPhasePayload
86
87# Add CompetitionPlayer to a competition.
88addCompetitionPlayer(input: AddCompetitionPlayerInput!): AddCompetitionPlayerPayload
89
90# Add CompetitionTeam to a competition.
91addCompetitionTeam(input: AddCompetitionTeamInput!): AddCompetitionTeamPayload
92
93# addDeviceToken associates a new push notification token to the given user.
94addDeviceToken(input: AddDeviceTokenInput!): AddDeviceTokenPayload
95
96# addDropToCampaign allows an organization to add a new drop record to an existing
97# campaign.
98addDropToCampaign(input: AddDropToCampaignInput!): AddDropToCampaignPayload
99
100# Grant a user the editor status for a given channel.
101addEditor(input: AddEditorInput!): AddEditorPayload
102
103# Register a radio content play start.
104addRadioRecentlyPlayed(
105input: AddRadioRecentlyPlayedInput!
106): AddRadioRecentlyPlayedPayload
107
108# addReaction allows a user to create a reaction for any reactable item in a feed.
109addReaction(
110input: AddReactionInput!
111): AddReactionPayload @deprecated( reason: "No longer supported" )
112
113# addRecommendationFeedback allows a user to add feedback about a recommendation
114# they've received.
115addRecommendationFeedback(
116input: AddRecommendationFeedbackInput!
117): AddRecommendationFeedbackPayload
118
119# Adds a user to stream on behalf of broadcaster.
120addStreamAuthorizedUser(
121input: AddStreamAuthorizedUserInput!
122): AddStreamAuthorizedUserPayload
123
124# Allocates product keys that a broadcaster may need to complete the bounty.
125allocateKeysForBounty(input: AllocateKeysForBountyInput!): AllocateKeysForBountyPayload
126
127# Allows a message rejected on a channel chat.
128allowRejectedChatMessage(
129input: AllowRejectedChatMessageInput!
130): AllowRejectedChatMessagePayload
131
132# Allows a cheer rejected on a channel chat.
133allowRejectedCheer(
134input: AllowRejectedCheerInput!
135): AllowRejectedCheerPayload @deprecated( reason: "logic handled by allowRejectedChatMessage" )
136
137# Apply activation state to a subset of installed extensions. In order to
138# deactivate an installed extension,
139# simply pass a null value in the anchor.
140applyExtensionActivations(
141input: ApplyExtensionActivationsInput!
142): ApplyExtensionActivationsPayload
143
144# Approve a request to be unbanned from a channel-banned user.
145approveUnbanRequest(input: ApproveUnbanRequestInput!): ApproveUnbanRequestPayload
146
147# Archives a chanlet to remove the chanlet from the parent channel.
148archiveChanlet(input: ArchiveChanletInput!): ArchiveChanletPayload
149
150# archiveCommunityPointsCommunityGoal archives a Community Points Community Goal.
151archiveCommunityPointsCommunityGoal(
152input: ArchiveCommunityPointsCommunityGoalInput!
153): ArchiveCommunityPointsCommunityGoalPayload
154
155# Archive a poll with the given poll id.
156archivePoll(input: ArchivePollInput!): ArchivePollPayload
157
158# Archive the current poll in a channel.
159archivePollInChannel(input: ArchivePollInChannelInput!): ArchivePollInChannelPayload
160
161# Assign an emote to a bits tier.
162assignEmoteToBitsTier(input: AssignEmoteToBitsTierInput!): AssignEmoteToBitsTierPayload
163
164# Assign an emote to a subscription product.
165assignEmoteToSubscriptionProduct(
166input: AssignEmoteToSubscriptionProductInput!
167): AssignEmoteToSubscriptionProductPayload
168
169# Assign a billing manager to an extension.
170# The billing manager is the organization's Owner or member with Billing_Manager
171# role that is ready to receive
172# payments for the monetized extension within an organization.
173assignExtensionBillingManager(
174input: AssignExtensionBillingManagerInput!
175): AssignExtensionBillingManagerPayload
176
177# Bans a user from chat room permanently or for an specified period of time.
178banUserFromChatRoom(input: BanUserFromChatRoomInput!): BanUserFromChatRoomPayload
179
180# banVideoCommenter bans a user from commenting on a video.
181banVideoCommenter(input: BanVideoCommenterInput!): BanVideoCommenterPayload
182
183# beginUseBitsInExtension starts a bits transaction in an extension.
184beginUseBitsInExtension(
185input: BeginUseBitsInExtensionInput!
186): BeginUseBitsInExtensionPayload
187
188# Blocks target user from communicating with the current user.
189blockUser(input: BlockUserInput!): BlockUserPayload
190
191# Approve a list of unban requests on a channel.
192bulkApproveUnbanRequest(
193input: BulkApproveUnbanRequestInput!
194): BulkApproveUnbanRequestPayload
195
196# Deny a list of unban requests on a channel.
197bulkDenyUnbanRequest(input: BulkDenyUnbanRequestInput!): BulkDenyUnbanRequestPayload
198
199# Cancel all active boosts on a channel.
200cancelActiveBoostOrders(
201input: CancelActiveBoostOrdersInput!
202): CancelActiveBoostOrdersPayload
203
204# cancelBounty allows a user to cancel a claimed bounty.
205# If the user has not met the requirements to cancel the bounty, an error will be
206# returned.
207cancelBounty(input: CancelBountyInput!): CancelBountyPayload
208
209# cancelFriendRequest destroys a friend request relationship from the
210# authenticated user to the target user.
211cancelFriendRequest(input: CancelFriendRequestInput!): CancelFriendRequestPayload
212
213# Cancel a current payout onboarding workflow.
214cancelPayoutOnboardingWorkflow(
215input: CancelPayoutOnboardingWorkflowInput!
216): CancelPayoutOnboardingWorkflowPayload
217
218# Cancel a Prediction Event.
219cancelPredictionEvent(input: CancelPredictionEventInput!): CancelPredictionEventPayload
220
221# Cancel a raid.
222cancelRaid(input: CancelRaidInput!): CancelRaidPayload
223
224# cancelSubscriptionGift allows the current user to cancel their gifted
225# subscription to a channel.
226cancelSubscriptionGift(
227input: CancelSubscriptionGiftInput!
228): CancelSubscriptionGiftPayload
229
230# cancelUnbanRequest allows the user to cancel their provided unban request.
231cancelUnbanRequest(input: CancelUnbanRequestInput!): CancelUnbanRequestPayload
232
233# changeUsername allows a user to update their username(login).
234changeUsername(input: ChangeUsernameInput!): ChangeUsernamePayload
235
236# claimBounty allows a user to claim a bounty from a campaign (e.g. Stream a Game
237# Campaign).
238# If the user has not met the requirements to claim it, an error will be returned.
239claimBounty(input: ClaimBountyInput!): ClaimBountyPayload
240
241# claimCommunityPoints allows a user to claim community points that they have
242# available in a channel.
243# If the user does not have a claim available, an error will be returned.
244claimCommunityPoints(input: ClaimCommunityPointsInput!): ClaimCommunityPointsPayload
245
246# claimDropRewards allows a user to attempt to claim their rewards from a Drops
247# 2.0 drop.
248claimDropRewards(input: ClaimDropRewardsInput!): ClaimDropRewardsPayload
249
250# claimPrimeOffer allows a user to create their entitlement to the given
251# offer/content.
252claimPrimeOffer(input: ClaimPrimeOfferInput!): ClaimPrimeOfferPayload
253
254# clearUnreadFriendRequests marks all friend requests for the authenticated user
255# as read.
256clearUnreadFriendRequests: ClearUnreadFriendRequestsPayload
257
258# cloneExtensionDiscoveryData copies the discovery data of an extension from one
259# version to another.
260cloneExtensionDiscoveryData(
261input: CloneExtensionDiscoveryDataInput!
262): CloneExtensionDiscoveryDataPayload
263
264# cloneExtensionManifest creates a new version of an extension that is a clone of
265# a previous version.
266cloneExtensionManifest(
267input: CloneExtensionManifestInput!
268): CloneExtensionManifestPayload
269
270# connectAdIdentity creates an Amazon ad identity for the authenticated user.
271connectAdIdentity(input: ConnectAdIdentityInput!): ConnectAdIdentityPayload
272
273# contributeCommunityPointsCommunityGoal contributes Community Points towards a
274# Community Goal.
275contributeCommunityPointsCommunityGoal(
276input: ContributeCommunityPointsCommunityGoalInput!
277): ContributeCommunityPointsCommunityGoalPayload
278
279# contributeToChallenge allows the user to contribute Bits towards a Challenge.
280contributeToChallenge(input: ContributeToChallengeInput!): ContributeToChallengePayload
281
282# createArchivedEmote creates an archived emote object, which is not associated
283# with any products, and associates that emote with a set of image assets.
284createArchivedEmote(input: CreateArchivedEmoteInput!): CreateArchivedEmotePayload
285
286# createBadgeFlair creates a custom badge flair asset for a creator's channel and
287# specified tier.
288createBadgeFlair(input: CreateBadgeFlairInput!): CreateBadgeFlairPayload
289
290# createBitsChallengeConditionForExtension creates a Bits condition on behalf of a
291# user by an extension.
292createBitsChallengeConditionForExtension(
293input: CreateBitsChallengeConditionForExtensionInput!
294): CreateBitsChallengeConditionForExtensionPayload
295
296# createBitsChallengeConditionParticipantForExtension creates a Bits condition
297# participant on behalf of a user by an extension.
298createBitsChallengeConditionParticipantForExtension(
299input: CreateBitsChallengeConditionParticipantForExtensionInput!
300): CreateBitsChallengeConditionParticipantForExtensionPayload
301
302# createBountyCampaign creates a campaign for Bounty Board.
303createBountyCampaign(input: CreateBountyCampaignInput!): CreateBountyCampaignPayload
304
305# createBountyCampaignUploadConfig creates a upload configuration for assets for
306# bounty campaigns.
307createBountyCampaignUploadConfig(
308input: CreateBountyCampaignUploadConfigInput!
309): CreateBountyCampaignUploadConfigPayload
310
311# createCelebration creates a new celebration for a channel.
312createCelebration(input: CreateCelebrationInput!): CreateCelebrationPayload
313
314# createChanlet creates a new chanlet for a Channel.
315createChanlet(input: CreateChanletInput!): CreateChanletPayload
316
317# createClip creates a new clip with the authenticated user as the curator.
318createClip(input: CreateClipInput!): CreateClipPayload
319
320# createCollection creates a collection with a provided collection name.
321createCollection(input: CreateCollectionInput!): CreateCollectionPayload
322
323# createCommunityPointsCommunityGoal creates a Community Points Community Goal.
324createCommunityPointsCommunityGoal(
325input: CreateCommunityPointsCommunityGoalInput!
326): CreateCommunityPointsCommunityGoalPayload
327
328# Create a custom Community Points reward in a channel.
329createCommunityPointsCustomReward(
330input: CreateCommunityPointsCustomRewardInput!
331): CreateCommunityPointsCustomRewardPayload
332
333# Generate image upload information (URL and upload ID) for uploading a Community
334# Points image.
335# Can upoload a new Community Points icon, an automatic reward icon, or a custom
336# reward icon.
337createCommunityPointsImageUploadInfo(
338input: CreateCommunityPointsImageUploadInfoInput!
339): CreateCommunityPointsImageUploadInfoPayload
340
341# Create a Competition.
342createCompetition(input: CreateCompetitionInput!): CreateCompetitionPayload
343
344# createContentTags creates the tags specified and associates it with the piece of
345# content specified.
346createContentTags(input: CreateContentTagsInput!): CreateContentTagsPayload
347
348# createDropBenefit creates a benefit that can be used within a drop campaign.
349createDropBenefit(input: CreateDropBenefitInput!): CreateDropBenefitPayload
350
351# createDropCampaign creates a Drop Campaign owned by an organization.
352createDropCampaign(input: CreateDropCampaignInput!): CreateDropCampaignPayload
353
354# createDropImageUploadURL creates and returns a url to use on the client side to
355# upload drops images.
356createDropImageUploadURL(
357input: CreateDropImageUploadURLInput!
358): CreateDropImageUploadURLPayload @deprecated( reason: "use dropImageUpload" )
359
360# createExtensionClient creates an extension with a provided name.
361createExtensionClient(input: CreateExtensionClientInput!): CreateExtensionClientPayload
362
363# createExtensionImageUploadInfo creates and returns a url and uploadId to use on
364# the client side to upload extension logo, taskbar, discovery and screenshot
365# images.
366createExtensionImageUploadInfo(
367input: CreateExtensionImageUploadInfoInput!
368): CreateExtensionImageUploadInfoPayload
369
370# createExtensionZipUploadInfo creates and returns a url and uploadId to use on
371# the client side to upload zip files.
372createExtensionZipUploadInfo(
373input: CreateExtensionZipUploadInfoInput!
374): CreateExtensionZipUploadInfoPayload
375
376# createFriendRequest creates a friend request relationship between the
377# authenticated user and the target user.
378createFriendRequest(input: CreateFriendRequestInput!): CreateFriendRequestPayload
379
380# createGameApplication creates an application request to add game to a certain
381# organization.
382createGameApplication(input: CreateGameApplicationInput!): CreateGameApplicationPayload
383
384# createGameBoxArtUploadURL returns a URL that can be used to upload the game box
385# art asset, for developers with access to the game box art image.
386createGameBoxArtUploadURL(
387input: CreateGameBoxArtUploadURLInput!
388): CreateGameBoxArtUploadURLPayload
389
390# CreateLoyaltyBadge creates a new badge with these settings.
391createLoyaltyBadge(input: CreateLoyaltyBadgeInput!): CreateLoyaltyBadgePayload
392
393# createLoyaltyBadgeUploadConfig creates a config with URL to upload the badge
394# image to.
395createLoyaltyBadgeUploadConfig(
396input: CreateLoyaltyBadgeUploadConfigInput!
397): CreateLoyaltyBadgeUploadConfigPayload
398
399# createModeratorComment creates and returns a comment on the target user in the
400# given channel.
401# Requester must be a moderator or higher in the channel.
402createModeratorComment(
403input: CreateModeratorCommentInput!
404): CreateModeratorCommentPayload
405
406# Creates a new custom Mosaic layout with the specified properties for the current
407# user.
408createDashboardViewMosaicLayout(
409input: CreateDashboardViewMosaicLayoutInput!
410): CreateDashboardViewMosaicLayoutPayload
411
412# createMultiVideoHighlight creates a video of type Highlight with multi-segment
413# support from an Archive type video.
414createMultiVideoHighlight(
415input: CreateMultiVideoHighlightInput!
416): CreateMultiVideoHighlightPayload
417
418# createMultiviewContentAttributeImageUploadConfig creates and returns a upload
419# configuration for uploading and retrieving content attribute images.
420createMultiviewContentAttributeImageUploadConfig(
421input: CreateMultiviewContentAttributeImageUploadConfigInput!
422): CreateMultiviewContentAttributeImageUploadConfigPayload
423
424# createMultiviewContentAttributes creates new content attributes with server
425# assigned IDs.
426createMultiviewContentAttributes(
427input: CreateMultiviewContentAttributesInput!
428): CreateMultiviewContentAttributesPayload
429
430# CreateOrganizationApplicaton creates a new Twitch Developer Organization
431# application with the authenticated user as the submitter.
432createOrganizationApplication(
433input: CreateOrganizationApplicationInput!
434): CreateOrganizationApplicationPayload
435
436# CreateOrganizationInvite creates a new invitation to join an existing Twitch
437# Developer Organization.
438createOrganizationInvite(
439input: CreateOrganizationInviteInput!
440): CreateOrganizationInvitePayload
441
442# Creates JWT to be used in subsequent drops calls.
443createOrganizationJWT(input: CreateOrganizationJWTInput!): CreateOrganizationJWTPayload
444
445# Adds a user to a developer organization.
446createOrganizationMember(
447input: CreateOrganizationMemberInput!
448): CreateOrganizationMemberPayload
449
450# createPanel removes a panel.
451createPanel(input: CreatePanelInput!): CreatePanelPayload
452
453# Creates the url that a panel image gets uploaded to.
454createPanelImageUploadInfo(
455input: CreatePanelImageUploadInfoInput!
456): CreatePanelImageUploadInfoPayload
457
458# createPartnershipApplication allows a user to create partnership application.
459createPartnershipApplication(
460input: CreatePartnershipApplicationInput!
461): CreatePartnershipApplicationPayload
462
463# createPoll creates a poll.
464createPoll(input: CreatePollInput!): CreatePollPayload
465
466# createPost creates a new post.
467createPost(
468input: CreatePostInput!
469): CreatePostPayload @deprecated( reason: "No longer supported" )
470
471# Create a new Prediction Event.
472createPredictionEvent(input: CreatePredictionEventInput!): CreatePredictionEventPayload
473
474# Create a raid.
475createRaid(input: CreateRaidInput!): CreateRaidPayload
476
477# createRewardedVideoToken creates a token used to initialize the truex client
478# application.
479createRewardedVideoToken(
480input: CreateRewardedVideoTokenInput!
481): CreateRewardedVideoTokenPayload
482
483# Creates a new chatroom.
484createRoom(
485input: CreateRoomInput!
486): CreateRoomPayload @deprecated( reason: "No longer supported" )
487
488# Create a new schedule.
489createSchedule(input: CreateScheduleInput!): CreateSchedulePayload
490
491# Create a new schedule segment.
492createScheduleSegment(input: CreateScheduleSegmentInput!): CreateScheduleSegmentPayload
493
494# createSocialMedia creates new social media items for a Channel.
495createSocialMedia(input: CreateSocialMediaInput!): CreateSocialMediaPayload
496
497# Creates an invitation to a new or existing squad stream.
498createSquadStreamInvitation(
499input: CreateSquadStreamInvitationInput!
500): CreateSquadStreamInvitationPayload
501
502# createStucco allows a user to create a stucco.
503createStucco(input: CreateStuccoInput!): CreateStuccoPayload
504
505# createStuccoPack allows the creation a new stucco pack for the channel.
506createStuccoPack(input: CreateStuccoPackInput!): CreateStuccoPackPayload
507
508# createUnbanRequest allows a channel-banned user to submit a request to channel
509# moderators to be unbanned.
510createUnbanRequest(input: CreateUnbanRequestInput!): CreateUnbanRequestPayload
511
512# createVideoAppeal creates an appeal for the tracks that have been flagged for
513# copyrighted music in the video.
514createVideoAppeal(input: CreateVideoAppealInput!): CreateVideoAppealPayload
515
516# createVideoBookmark creates a video bookmark.
517createVideoBookmark(input: CreateVideoBookmarkInput!): CreateVideoBookmarkPayload
518
519# createVideoComment creates a video comment.
520createVideoComment(input: CreateVideoCommentInput!): CreateVideoCommentPayload
521
522# createVideoHighlight creates a video of type Highlight from an Archive type
523# video.
524createVideoHighlight(input: CreateVideoHighlightInput!): CreateVideoHighlightPayload
525
526# createVideoThumbnailUploadRequest creates a thumbnail upload request url.
527createVideoThumbnailUploadRequest(
528input: CreateVideoThumbnailUploadRequestInput!
529): CreateVideoThumbnailUploadRequestPayload
530
531# Deactivate an extension which has been installed on a channel.
532deactivateExtension(
533input: DeactivateExtensionInput!
534): DeactivateExtensionPayload @deprecated( reason: "Should use applyExtensionActivations instead" )
535
536# DeclineOrganizationInvite declines an invite to an organization and the
537# invitation is deleted.
538declineOrganizationInvite(
539input: DeclineOrganizationInviteInput!
540): DeclineOrganizationInvitePayload
541
542# deleteAllChannelVideos deletes all videos for a given channel id for the
543# authenticated users.
544deleteAllChannelVideos(
545input: DeleteAllChannelVideosInput
546): DeleteAllChannelVideosPayload
547
548# Deletes a bits badge tier emoticon.
549deleteBitsBadgeTierEmoticon(
550input: DeleteBitsBadgeTierEmoticonInput!
551): DeleteBitsBadgeTierEmoticonPayload
552
553# Deletes a celebration from the channel.
554deleteCelebration(input: DeleteCelebrationInput!): DeleteCelebrationPayload
555
556# Deletes a blocked term from a channel.
557deleteChannelBlockedTerm(
558input: DeleteChannelBlockedTermInput!
559): DeleteChannelBlockedTermPayload
560
561# Deletes clips from a channel.
562deleteChannelClips(input: DeleteChannelClipsInput!): DeleteChannelClipsPayload
563
564# Deletes a permitted term from a channel.
565deleteChannelPermittedTerm(
566input: DeleteChannelPermittedTermInput!
567): DeleteChannelPermittedTermPayload
568
569# deleteChatMessage deletes a single message from stream chat.
570deleteChatMessage(input: DeleteChatMessageInput!): DeleteChatMessagePayload
571
572# Deletes a custom cheermote tier from a channel.
573deleteCheermoteTier(input: DeleteCheermoteTierInput!): DeleteCheermoteTierPayload
574
575# deleteClips allows a user to delete clips by slugs, video id, or broadcast id.
576# Only the slug and id can be accessed from the list of deleted clips.
577deleteClips(input: DeleteClipsInput!): DeleteClipsPayload
578
579# deleteCollection performs a delete on the collection with the provided ID.
580deleteCollection(input: DeleteCollectionInput!): DeleteCollectionPayload
581
582# deleteCommunityPointsCommunityGoal deletes a Community Points Community Goal.
583deleteCommunityPointsCommunityGoal(
584input: DeleteCommunityPointsCommunityGoalInput!
585): DeleteCommunityPointsCommunityGoalPayload
586
587# Deletes a custom Community Points reward from a channel.
588deleteCommunityPointsCustomReward(
589input: DeleteCommunityPointsCustomRewardInput
590): DeleteCommunityPointsCustomRewardPayload
591
592# Delete a Competition.
593deleteCompetition(input: DeleteCompetitionInput!): DeleteCompetitionPayload
594
595# deleteContentTags removes the tags specified and associates it with the piece of
596# content specified.
597deleteContentTags(input: DeleteContentTagsInput!): DeleteContentTagsPayload
598
599# Deletes the default payment method for a user.
600# Currently supports the Zuora (credit card) and Recurly (credit card,
601# Pay-with-Amazon, PayPal) payment providers.
602deleteDefaultPaymentMethod(
603input: DeleteDefaultPaymentMethodInput!
604): DeleteDefaultPaymentMethodPayload
605
606# deleteDeviceToken deletes a previously added device token by user and device
607# token ID.
608deleteDeviceToken(input: DeleteDeviceTokenInput!): DeleteDeviceTokenPayload
609
610# deleteDrop allows a drop organization owner to delete a drop from their
611# organization.
612deleteDrop(input: DeleteDropInput!): DeleteDropPayload
613
614# deleteDropCampaign allows a drop campaign owner to delete a drop campaign.
615deleteDropCampaign(input: DeleteDropCampaignInput!): DeleteDropCampaignPayload
616
617# Deletes a specified emote.
618deleteEmote(input: DeleteEmoteInput!): DeleteEmotePayload
619
620# deleteExtension allows an extension owner to delete an extension.
621deleteExtension(input: DeleteExtensionInput!): DeleteExtensionPayload
622
623# deleteExtensionImage delete extension image assets of the given urls.
624deleteExtensionImage(input: DeleteExtensionImageInput!): DeleteExtensionImagePayload
625
626# Delete all secrets associated with an extension; this will immediately break all
627# clients until
628# both a new secret rotate is executed and the clients manually refresh
629# themselves. Only use this
630# if a secret is compromised and must be immediately removed from circulation.
631deleteExtensionSecrets(
632input: DeleteExtensionSecretsInput!
633): DeleteExtensionSecretsPayload
634
635# Deletes a Loyalty Badge of a Channel.
636deleteLoyaltyBadge(input: DeleteLoyaltyBadgeInput!): DeleteLoyaltyBadgePayload
637
638# deleteModeratorComment deletes a moderator comment with the given ID.
639# The comment must have been created on the requester's channel.
640deleteModeratorComment(
641input: DeleteModeratorCommentInput!
642): DeleteModeratorCommentPayload
643
644# deleteMultiviewContentAttributes deletes content attributes with the provided
645# IDs.
646deleteMultiviewContentAttributes(
647input: DeleteMultiviewContentAttributesInput!
648): DeleteMultiviewContentAttributesPayload
649
650# deleteNotification deletes an onsite notification of the authenticated user.
651deleteNotification(input: DeleteNotificationInput!): DeleteNotificationPayload
652
653# deletePanel removes a panel.
654deletePanel(input: DeletePanelInput!): DeletePanelPayload
655
656# deletePost deletes a old post.
657deletePost(
658input: DeletePostInput!
659): DeletePostPayload @deprecated( reason: "No longer supported" )
660
661# deleteRecommendationFeedback deletes all the recommendation feedback that
662# matches the given input.
663deleteRecommendationFeedback(
664input: DeleteRecommendationFeedbackInput!
665): DeleteRecommendationFeedbackPayload
666
667# Deletes a chatroom.
668deleteRoom(
669input: DeleteRoomInput!
670): DeleteRoomPayload @deprecated( reason: "No longer supported" )
671
672# Deletes an existing message in a chatroom.
673deleteRoomMessage(input: DeleteRoomMessageInput!): DeleteRoomMessagePayload
674
675# Delete the entire schedule of a user.
676deleteSchedule(input: DeleteScheduleInput!): DeleteSchedulePayload
677
678# Delete a segment of a schedule of a user.
679deleteScheduleSegment(input: DeleteScheduleSegmentInput!): DeleteScheduleSegmentPayload
680
681# deleteSocialMedia deletes a social media item for a Channel.
682deleteSocialMedia(input: DeleteSocialMediaInput!): DeleteSocialMediaPayload
683
684# deleteSquadStreamInvitation allows a squad stream member to delete a squad
685# stream invitation.
686deleteSquadStreamInvitation(
687input: DeleteSquadStreamInvitationInput!
688): DeleteSquadStreamInvitationPayload
689
690# Deletes an authorized user who was allowed to stream on behalf of broadcaster.
691deleteStreamAuthorizedUser(
692input: DeleteStreamAuthorizedUserInput!
693): DeleteStreamAuthorizedUserPayload
694
695# Deletes clips made by user.
696deleteUserClips(input: DeleteUserClipsInput!): DeleteUserClipsPayload
697
698# Deletes a user's creator colors.
699deleteUserColors(input: DeleteUserColorsInput!): DeleteUserColorsPayload
700
701# deleteVideoComment performs a delete on the video comment with the provided
702# comment ID.
703# NOTE: this should use an input argument, not define the commentID right here.
704deleteVideoComment(commentID: ID!): DeleteVideoCommentPayload
705
706# deleteVideos performs a delete on the list of video ids.
707deleteVideos(input: DeleteVideosInput!): DeleteVideosPayload
708
709# deleteVideoThumbnail deletes a thumbnail from a video.
710deleteVideoThumbnail(input: DeleteVideoThumbnailInput!): DeleteVideoThumbnailPayload
711
712# Denies a message rejected on a channel chat.
713denyRejectedChatMessage(
714input: DenyRejectedChatMessageInput!
715): DenyRejectedChatMessagePayload
716
717# Denies a cheer rejected on a channel chat.
718denyRejectedCheer(
719input: DenyRejectedCheerInput!
720): DenyRejectedCheerPayload @deprecated( reason: "logic handled by denyRejectedChatMessage" )
721
722# Deny an unban request from a channel-banned user.
723denyUnbanRequest(input: DenyUnbanRequestInput!): DenyUnbanRequestPayload
724
725# Deselect channel badge (default to global badge).
726deselectChannelBadge(input: DeselectChannelBadgeInput!): DeselectChannelBadgePayload
727
728# Deselect global badge (default to no badge).
729deselectGlobalBadge: DeselectGlobalBadgePayload
730
731# Disables Two Factor Authentication for a Twitch user. Requires sudo
732# authentication.
733disableTwoFactor(input: DisableTwoFactorInput!): DisableTwoFactorPayload
734
735# Allows the current user to disable or permanently delete their own account.
736disableUserAccount(input: DisableUserAccountInput!): DisableUserAccountPayload
737
738# dismissFriendRecommendation removes a friend recommendation to the authenticated
739# user without creating a friend
740# request.
741dismissFriendRecommendation(
742input: DismissFriendRecommendationInput!
743): DismissFriendRecommendationPayload
744
745# Permanently dismiss a ritual token without redeeming it.
746dismissRitualToken(input: DismissRitualTokenInput!): DismissRitualTokenPayload
747
748# dismissVideoSuggestedHighlight dismisses the automated highlight suggestion for
749# a video.
750dismissVideoSuggestedHighlight(
751input: DismissVideoSuggestedHighlightInput!
752): DismissVideoSuggestedHighlightPayload
753
754# dropImageUpload makes a request for a url to upload an image to. The caller can
755# then use the URL to upload an image
756# of their choice for either a drop or a benefit.
757dropImageUpload(input: DropImageUploadInput!): DropImageUploadPayload
758
759# Edits an existing message in a chatroom.
760editRoomMessage(
761input: EditRoomMessageInput!
762): EditRoomMessagePayload @deprecated( reason: "No longer supported" )
763
764# emitCampaignDiscoveryEvent updates a user's progress towards a discovery
765# objective in applicable campaigns.
766emitCampaignDiscoveryEvent(
767input: EmitCampaignDiscoveryEventInput!
768): EmitCampaignDiscoveryEventPayload @deprecated( reason: "No longer supported" )
769
770# endUseBitsInExtension completes the bit usage transaction in an extension.
771endUseBitsInExtension(input: EndUseBitsInExtensionInput!): EndUseBitsInExtensionPayload
772
773# equipHeroAssets adds the specified assets to a user's hero.
774equipHeroAssets(input: EquipHeroAssetsInput!): EquipHeroAssetsPayload
775
776# exportVideoToYoutube allows a user to export a video to Youtube.
777exportVideoToYoutube(input: ExportVideoToYoutubeInput!): ExportVideoToYoutubePayload
778
779# extensionLinkUser enables or disables the user's identity sharing with an
780# extension.
781extensionLinkUser(input: ExtensionLinkUserInput!): ExtensionLinkUserPayload
782
783# finalizeCompetitionLobby update's a lobby's state to DONE and progresses the
784# competition.
785finalizeCompetitionLobby(
786input: FinalizeCompetitionLobbyInput!
787): FinalizeCompetitionLobbyPayload
788
789# followGame allows a user to follow a game.
790followGame(input: FollowGameInput!): FollowGamePayload
791
792# followUser creates a follow relationship between the authenticated user and
793# the target user.
794followUser(input: FollowUserInput!): FollowUserPayload
795
796# generateAnimatedEmote kicks off the generation of animated .gif assets from a
797# given animation preset and static image ids.
798# The user will be notified of success or failure on pubsub.
799generateAnimatedEmote(input: GenerateAnimatedEmoteInput!): GenerateAnimatedEmotePayload
800
801# generateExtensionRatingsCSVReport asks the ExtensionRatings backend to generate
802# a report and return a filename
803# for that report. The filename can then be used in follow-up calls to
804# getReportPresignedURL to poll for its
805# completion. Authenticated on userID:extensionID via OWL in the ExtensionRatings
806# backend.
807generateExtensionRatingsCSVReport(
808input: GenerateExtensionRatingsCSVReportInput!
809): GenerateExtensionRatingsCSVReportPayload
810
811# generateSecondFactorQRCode generates a new second factor QR code so it can be
812# used to generate OTP for authentication.
813# The mutation requires sudo privilege to be successful.
814generateSecondFactorQRCode(
815input: GenerateSecondFactorQRCodeInput!
816): GenerateSecondFactorQRCodePayload
817
818# generateSubscribersCSV kicks off a background job that will generate a csv
819# containing a list
820# of the channel's subscribers and then will alert the frontend that the csv is
821# ready to
822# download using pubsub. Authenticated on the channelID.
823generateSubscribersCSV(
824input: GenerateSubscribersCSVInput!
825): GenerateSubscribersCSVPayload
826
827# getEmoteUploadConfig makes a request to mako to get emote upload configuration
828# for a user to upload a new emote with.
829getEmoteUploadConfig(input: GetEmoteUploadConfigInput!): GetEmoteUploadConfigPayload
830
831# Start a raid.
832goRaid(input: GoRaidInput!): GoRaidPayload
833
834# Grant the VIP status to a user for a channel.
835grantVIP(input: GrantVIPInput!): GrantVIPPayload
836
837# Host a target channel from a channel.
838hostTargetChannel(input: HostTargetChannelInput!): HostTargetChannelPayload
839
840# Install an extension onto a specific channel.
841installExtension(input: InstallExtensionInput!): InstallExtensionPayload
842
843# Disable the schedule of a user.
844interruptSchedule(input: InterruptScheduleInput!): InterruptSchedulePayload
845
846# Invalidates authenticated sessions.
847invalidateAuthenticatedSessions(
848input: InvalidateAuthenticatedSessionsInput!
849): InvalidateAuthenticatedSessionsPayload
850
851# Invalidates an association to an email.
852invalidateEmailAssociation(
853input: InvalidateEmailAssociationInput!
854): InvalidateEmailAssociationPayload
855
856# Joins the channel's chatrooms.
857joinChannelRooms(
858input: JoinChannelRoomsInput!
859): JoinChannelRoomsPayload @deprecated( reason: "No longer supported" )
860
861# Add a viewer to a source channel's raid. The viewer will be redirected to the
862# target channel when the raid starts.
863joinRaid(input: JoinRaidInput!): JoinRaidPayload
864
865# Leaves the channel's chatrooms.
866leaveChannelRooms(
867input: LeaveChannelRoomsInput!
868): LeaveChannelRoomsPayload @deprecated( reason: "No longer supported" )
869
870# Leave a raid for a viewer.
871leaveRaid(input: LeaveRaidInput!): LeaveRaidPayload
872
873# leaveSquadStream allows a member of a squad stream to leave the squad. Their
874# stream will be
875# removed from the viewer experience, and they will be free to start/join another
876# squad stream.
877leaveSquadStream(input: LeaveSquadStreamInput!): LeaveSquadStreamPayload
878
879# Link a single sign-on (SSO) app to a user's account.
880linkSSO(
881input: LinkSSOInput!
882): LinkSSOPayload @deprecated( reason: "Service has been shutdown" )
883
884# Update a Prediction Event from ACTIVE to LOCKED, so that users can no longer
885# make predictions on it.
886lockPredictionEvent(input: LockPredictionEventInput!): LockPredictionEventPayload
887
888# Makes a download URL for an authorized user to download a batch of keys.
889makeKeyBatchDownloadURL(
890input: MakeKeyBatchDownloadURLInput!
891): MakeKeyBatchDownloadURLPayload
892
893# Make a prediction on an active Prediction Event.
894makePrediction(input: MakePredictionInput!): MakePredictionPayload
895
896# Manually triggers drop in Drops 2.0 system.
897manuallyTriggerDrop(input: ManuallyTriggerDropInput!): ManuallyTriggerDropPayload
898
899# ReadAllCreatorNotifications marks all creator notifications as read.
900markAllCreatorNotificationsAsRead(
901input: MarkAllCreatorNotificationsAsReadInput!
902): MarkAllCreatorNotificationsAsReadPayload
903
904# ReadAllViewerNotifications marks all viewer notifications as read.
905markAllViewerNotificationsAsRead(
906input: MarkAllViewerNotificationsAsReadInput
907): MarkAllViewerNotificationsAsReadPayload
908
909# Make a user a moderator for a channel.
910modUser(input: ModUserInput!): ModUserPayload
911
912# orderPanels updates the sort order of the provided panels, the input must be a
913# list of panel ids
914# all of which are owned by the acting user otherwise the request will fail and a
915# generic GraphQL
916# error will be returned.
917orderPanels(input: OrderPanelsInput!): OrderPanelsPayload
918
919# Presign and return a secure S3 URL to download a CSV report for a GAME or
920# EXTENSION.
921# The generated CSV report contains rows for every day after 2018-01-31.
922presignDevInsightsReportURL(
923input: PresignDevInsightsReportURLInput!
924): PresignDevInsightsReportURLPayload
925
926# processAndroidPayment processes an off-platform Android payment (user was
927# charged outside the Twitch platform).
928# See also: processIOSPayment (iOS purchases) and purchaseOffer (on-platform
929# purchases).
930processAndroidPayment(input: ProcessAndroidPaymentInput!): ProcessAndroidPaymentPayload
931
932# processIOSPayment processes an off-platform iOS payment (user was charged
933# outside the Twitch platform).
934# See also: processAndroidPayment (Android purchases) and purchaseOffer
935# (on-platform purchases).
936processIOSPayment(input: ProcessIOSPaymentInput!): ProcessIOSPaymentPayload
937
938# publishClip allows a user to permanently edit and update their default clip,
939# viewable to the public.
940publishClip(input: PublishClipInput!): PublishClipPayload
941
942# Publishes a competition to make it visible on the esports page.
943publishCompetition(input: PublishCompetitionInput!): PublishCompetitionPayload
944
945# Publishes a subscription emote to become available with a subscription product.
946publishSubscriptionEmote(
947input: PublishSubscriptionEmoteInput!
948): PublishSubscriptionEmotePayload
949
950# purchaseOffer completes the purchase of an offer made inside the Twitch
951# platform.
952# See also: processAndroidPayment (Android purchases) and processIOSPayment.
953purchaseOffer(input: PurchaseOfferInput!): PurchaseOfferPayload
954
955# Submit a rating for a Twitch extension.
956rateExtension(input: RateExtensionInput!): RateExtensionPayload
957
958# readNotifications sets the read state to true for one or more onsite
959# notifications of the authenticated user.
960readNotifications(input: ReadNotificationsInput!): ReadNotificationsPayload
961
962# Record an ad event.
963recordAdEvent(input: RecordAdEventInput!): RecordAdEventPayload
964
965# Redeem a claimable code, like a bits key code to add bits to your account, etc.
966redeemClaimable(input: RedeemClaimableInput!): RedeemClaimablePayload
967
968# Redeem a Community Points custom reward in a channel.
969redeemCommunityPointsCustomReward(
970input: RedeemCommunityPointsCustomRewardInput!
971): RedeemCommunityPointsCustomRewardPayload
972
973# Redeem a set of creator gift subscriptions.
974redeemCreatorGifts(input: RedeemCreatorGiftsInput!): RedeemCreatorGiftsPayload
975
976# Redeem an available ritual token. Currently, tokens are redeemed by sending
977# a special message to a channel's chat.
978redeemRitualToken(input: RedeemRitualTokenInput!): RedeemRitualTokenPayload
979
980# Submit a Subscription Redemption.
981redeemSubscription(input: RedeemSubscriptionInput!): RedeemSubscriptionPayload
982
983# redeemTrueXAd processes the result of watching an ad to earn bits.
984# This action can only be taken if an OAuth token is supplied with the request.
985redeemTrueXAd(input: RedeemTrueXAdInput!): RedeemTrueXAdPayload
986
987# refreshExtensionToken is used by our client on a timer to ensure the token
988# doesn't expire while the user is using the site.
989refreshExtensionToken(input: RefreshExtensionTokenInput!): RefreshExtensionTokenPayload
990
991# regenerateStreamKey generates a new stream key for the broadcaster and returns
992# the newly generated stream key.
993regenerateStreamKey(input: RegenerateStreamKeyInput!): RegenerateStreamKeyPayload
994
995# regenerateVerificationCode generates a new verification code and resends the
996# verification message with the new code.
997regenerateVerificationCode(
998input: RegenerateVerificationCodeInput!
999): RegenerateVerificationCodePayload
1000
1001# Register payout information during payout onboarding.
1002registerPayoutInformation(
1003input: RegisterPayoutInformationInput!
1004): RegisterPayoutInformationPayload
1005
1006# Starts the registration for second factor authentication for a twitch user.
1007# Requires sudo authentication.
1008registerTwoFactor(input: RegisterTwoFactorInput!): RegisterTwoFactorPayload
1009
1010# Finishes the registration for second factor authentication for a twitch user.
1011# Requires sudo authentication.
1012registerTwoFactorConfirmation(
1013input: RegisterTwoFactorConfirmationInput!
1014): RegisterTwoFactorConfirmationPayload
1015
1016# rejectFriendRequest destroys a friend request relationship from the target user
1017# to the authenticated user.
1018rejectFriendRequest(input: RejectFriendRequestInput!): RejectFriendRequestPayload
1019
1020# rejectSquadStreamInvitation allows a user to decline an invitation to join a
1021# squad stream.
1022rejectSquadStreamInvitation(
1023input: RejectSquadStreamInvitationInput!
1024): RejectSquadStreamInvitationPayload
1025
1026# rejectSquadStreamOutOfNetworkInvitations allows a user to decline all
1027# out-of-network invitations to join a squad stream.
1028rejectSquadStreamOutOfNetworkInvitations(
1029input: RejectSquadStreamOutOfNetworkInvitationsInput!
1030): RejectSquadStreamOutOfNetworkInvitationsPayload
1031
1032# Removes channels from a user's AutoHost list.
1033removeAutohostChannels(
1034input: RemoveAutohostChannelsInput!
1035): RemoveAutohostChannelsPayload
1036
1037# removeCollectionItem removes an item from a collection.
1038removeCollectionItem(input: RemoveCollectionItemInput!): RemoveCollectionItemPayload
1039
1040# Remove a phase from a Competition.
1041removeCompetitionPhase(
1042input: RemoveCompetitionPhaseInput!
1043): RemoveCompetitionPhasePayload
1044
1045# Remove CompetitionPlayer from a competition.
1046removeCompetitionPlayer(
1047input: RemoveCompetitionPlayerInput!
1048): RemoveCompetitionPlayerPayload
1049
1050# Remove a competition team from a Competition.
1051removeCompetitionTeam(input: RemoveCompetitionTeamInput!): RemoveCompetitionTeamPayload
1052
1053# Revoke the editor status from a user for a given channel.
1054removeEditor(input: RemoveEditorInput!): RemoveEditorPayload
1055
1056# Remove an emote from its assigned group.
1057removeEmoteFromGroup(input: RemoveEmoteFromGroupInput!): RemoveEmoteFromGroupPayload
1058
1059# Removes a rbac user from a developer organization.
1060removeOrganizationMember(
1061input: RemoveOrganizationMemberInput!
1062): RemoveOrganizationMemberPayload
1063
1064# removeReaction removes a reaction created with addReaction.
1065removeReaction(
1066input: RemoveReactionInput!
1067): RemoveReactionPayload @deprecated( reason: "No longer supported" )
1068
1069# removeSquadStreamMember allows the owner of a squad stream to remove a member
1070# from the squad stream.
1071removeSquadStreamMember(
1072input: RemoveSquadStreamMemberInput!
1073): RemoveSquadStreamMemberPayload
1074
1075# removeStucco allows the owner of a stucco to remove an inactive stucco from
1076# their library.
1077removeStucco(input: RemoveStuccoInput!): RemoveStuccoPayload
1078
1079# reorderCollectionItem reorders an item's position in a collection.
1080reorderCollectionItem(input: ReorderCollectionItemInput!): ReorderCollectionItemPayload
1081
1082# reportContent allows a user to report content on the site as infringing of our
1083# terms of service.
1084reportContent(input: ReportContentInput!): ReportContentPayload
1085
1086# Reports a user for bad behavior in a whisper thread.
1087reportWhisper(input: ReportWhisperInput!): ReportWhisperPayload
1088
1089# Reports a whisper thread as spam.
1090reportWhisperThread(
1091input: ReportWhisperThreadInput!
1092): ReportWhisperThreadPayload @deprecated( reason: "Use reportWhisper" )
1093
1094# Request a ritual token to be issued to the user.
1095requestRitualToken(input: RequestRitualTokenInput!): RequestRitualTokenPayload
1096
1097# resendVerificationEmail resends a verification email to the current user.
1098resendVerificationEmail(
1099input: ResendVerificationEmailInput!
1100): ResendVerificationEmailPayload
1101
1102# resetUsername allows a user to update their flagged username.
1103resetUsername(input: ResetUsernameInput!): ResetUsernamePayload
1104
1105# Resolve a Prediction Event by specifying the winning option.
1106resolvePredictionEvent(
1107input: ResolvePredictionEventInput!
1108): ResolvePredictionEventPayload
1109
1110# Respond to a team invitation by accepting or declining.
1111respondToTeamInvitation(
1112input: RespondToTeamInvitationInput!
1113): RespondToTeamInvitationPayload
1114
1115# Enable the schedule of a user.
1116resumeSchedule(input: ResumeScheduleInput!): ResumeSchedulePayload
1117
1118# Revoke the VIP status of a user from a channel.
1119revokeVIP(input: RevokeVIPInput!): RevokeVIPPayload
1120
1121# Request a new extension secret; automatically rotates any current secrets out of
1122# service
1123# with enough time for extension clients to gracefully switch over. This function
1124# should
1125# only be called when you are ready to install the new set of secrets it will
1126# return; use
1127# GET to view secrets without rotating them.
1128rotateExtensionSecrets(
1129input: RotateExtensionSecretsInput!
1130): RotateExtensionSecretsPayload
1131
1132# Runs multiplayer ads on a channel.
1133runMultiplayerAds(input: RunMultiplayerAdsInput!): RunMultiplayerAdsPayload
1134
1135# saveExtensionManifest allows a user to update the manifest for an extension in
1136# development.
1137saveExtensionManifest(input: SaveExtensionManifestInput!): SaveExtensionManifestPayload
1138
1139# Give a competition participant a seed value.
1140seedCompetitionParticipant(
1141input: SeedCompetitionParticipantInput!
1142): SeedCompetitionParticipantPayload
1143
1144# Select a user's channel badge for a channel.
1145selectChannelBadge(input: SelectChannelBadgeInput!): SelectChannelBadgePayload
1146
1147# Select a user's global badge.
1148selectGlobalBadge(input: SelectGlobalBadgeInput!): SelectGlobalBadgePayload
1149
1150# Send a chat message through subscribers-only mode with Channel Points.
1151sendChatMessageThroughSubscriberMode(
1152input: SendChatMessageThroughSubscriberModeInput!
1153): SendChatMessageThroughSubscriberModePayload
1154
1155# sendCheer sends a chat message that contains cheermotes. The message will
1156# be processed, bits deducted from the authenticated user's balance, and then the
1157# message will be passed on to the chat service (client shouldn't send the message
1158# itself).
1159# This action can only be taken if an OAuth token is supplied with the request.
1160sendCheer(input: SendCheerInput!): SendCheerPayload
1161
1162# Sends a pubsub message on behalf of an Extension.
1163sendExtensionMessage(input: SendExtensionMessageInput!): SendExtensionMessagePayload
1164
1165# Send a highlighted chat message with Channel Points.
1166sendHighlightedChatMessage(
1167input: SendHighlightedChatMessageInput!
1168): SendHighlightedChatMessagePayload
1169
1170# Sends a message to a chatroom.
1171sendRoomMessage(
1172input: SendRoomMessageInput!
1173): SendRoomMessagePayload @deprecated( reason: "No longer supported" )
1174
1175# Sends a whisper message to the target user.
1176sendWhisper(input: SendWhisperInput!): SendWhisperPayload
1177
1178# Set values for length and period of ads for channel ads management.
1179setAutoAdDensity(input: SetAutoAdDensityInput!): SetAutoAdDensityPayload
1180
1181# Sets the user's auto refill settings.
1182setAutoRefillSettings(input: SetAutoRefillSettingsInput!): SetAutoRefillSettingsPayload
1183
1184# Sets the user's list of channelIDs to autohost.
1185setAutohostChannels(input: SetAutohostChannelsInput!): SetAutohostChannelsPayload
1186
1187# setBitsUserSettings sets a Bits users settings such as skipping the tutorial.
1188setBitsUserSettings(input: SetBitsUserSettingsInput!): SetBitsUserSettingsPayload
1189
1190# Set value for channel_feed_enabled.
1191setChannelFeedEnabled(
1192input: SetChannelFeedEnabledInput!
1193): SetChannelFeedEnabledPayload @deprecated( reason: "No longer supported" )
1194
1195# setChannelNotificationSetting allows a user to set a notification setting.
1196setChannelNotificationSetting(
1197input: SetChannelNotificationSettingInput!
1198): SetChannelNotificationSettingPayload
1199
1200# Set a channel's trailer.
1201# A channel trailer can only be modified by its corresponding user, a channel
1202# editor, or a Twitch admin.
1203setChannelTrailer(input: SetChannelTrailerInput!): SetChannelTrailerPayload
1204
1205# Set a user's Chat Pause setting.
1206setChatPauseSetting(input: SetChatPauseSettingInput!): SetChatPauseSettingPayload
1207
1208# setContentTags updates the tags specified and associates it with the piece of
1209# content specified.
1210setContentTags(input: SetContentTagsInput!): SetContentTagsPayload
1211
1212# setCreatorBadgeFlair updates the channel-wide setting for a user that determines
1213# what
1214# type of subscriber badge flair is available to eligible subscribers to that
1215# channel.
1216setCreatorBadgeFlair(input: SetCreatorBadgeFlairInput!): SetCreatorBadgeFlairPayload
1217
1218# setDashboardAlertQueueActivityStatus updates the specified activity's status for
1219# the dashboard alert queue.
1220setDashboardAlertQueueActivityStatus(
1221input: SetDashboardAlertQueueActivityStatusInput!
1222): SetDashboardAlertQueueActivityStatusPayload
1223
1224# setDashboardAlertQueuePreference updates the preference specified for the
1225# dashboard alert queue.
1226setDashboardAlertQueuePreference(
1227input: SetDashboardAlertQueuePreferenceInput!
1228): SetDashboardAlertQueuePreferencePayload
1229
1230# Sets the default payment method for a user.
1231# Currently supports the Zuora (credit card) and Recurly (credit card,
1232# Pay-with-Amazon, PayPal) payment providers
1233# This is the final step of the payment method management flow.
1234# (User.paymentMethods -> User.paymentMethodConfigs -> this mutation).
1235setDefaultPaymentMethod(
1236input: SetDefaultPaymentMethodInput!
1237): SetDefaultPaymentMethodPayload
1238
1239# Set a user's Deleted Message Display Chat UI setting.
1240setDeletedMessageDisplaySetting(
1241input: SetDeletedMessageDisplaySettingInput!
1242): SetDeletedMessageDisplaySettingPayload
1243
1244# SetDropBenefitOnDrop adds a benefit to a drop within a drop campaign.
1245setDropBenefitsOnDrop(input: SetDropBenefitsOnDropInput!): SetDropBenefitsOnDropPayload
1246
1247# setDropCampaignAccess updates who can or cannot access a campaign's drops.
1248setDropCampaignAccess(input: SetDropCampaignAccessInput!): SetDropCampaignAccessPayload
1249
1250# setDropCampaignStatus transitions a campaign between states.
1251setDropCampaignStatus(input: SetDropCampaignStatusInput!): SetDropCampaignStatusPayload
1252
1253# setDropCampaignSummary allows organizations in the devconsole to update a
1254# previously created campaign's summary.
1255setDropCampaignSummary(
1256input: SetDropCampaignSummaryInput!
1257): SetDropCampaignSummaryPayload
1258
1259# setDropEventRule updates a drops's rule to be an event based rule.
1260setDropEventRule(input: SetDropEventRuleInput!): SetDropEventRulePayload
1261
1262# setDropSummary allows organizations to update a drop's summary data.
1263setDropSummary(input: SetDropSummaryInput!): SetDropSummaryPayload
1264
1265# setDropTimeBasedRule updates a drops's rule to be a minutes watched based rule.
1266setDropTimeBasedRule(input: SetDropTimeBasedRuleInput!): SetDropTimeBasedRulePayload
1267
1268# Set a user's emote animations UI setting.
1269setEmoteAnimationsEnabled(
1270input: SetEmoteAnimationsEnabledInput!
1271): SetEmoteAnimationsEnabledPayload
1272
1273# Set a user's emote animations callout dismissed setting.
1274setEmoteAnimationsSettingCalloutDismissed(
1275input: SetEmoteAnimationsSettingCalloutDismissedInput!
1276): SetEmoteAnimationsSettingCalloutDismissedPayload
1277
1278# Sets the emote modifier groups for a user.
1279setEmoteModifierGroups(
1280input: SetEmoteModifierGroupsInput!
1281): SetEmoteModifierGroupsPayload
1282
1283# Sets the configuration for an extension version.
1284setExtensionConfiguration(
1285input: SetExtensionConfigurationInput!
1286): SetExtensionConfigurationPayload
1287
1288# Sets the feature flag options on a specified extension installation.
1289setExtensionFeatureFlags(
1290input: SetExtensionFeatureFlagsInput!
1291): SetExtensionFeatureFlagsPayload
1292
1293# Set the OAuth token for an installation which is retrieved and used for Helix
1294# requests from extensions.
1295setExtensionInstallationOAuth(
1296input: SetExtensionInstallationOAuthInput!
1297): SetExtensionInstallationOAuthPayload
1298
1299# SetGameDropAccountLinkClient sets the client ID on a game which is used to
1300# verify that users have connected their game accounts.
1301setGameDropAccountLinkClient(
1302input: SetGameDropAccountLinkClientInput!
1303): SetGameDropAccountLinkClientPayload
1304
1305# Sets the user's current hero to their profile picture.
1306setHeroAsAvatar(input: SetHeroAsAvatarInput!): SetHeroAsAvatarPayload
1307
1308# Set access permission to the channel's moderator logs for a given role.
1309setModLogsAccess(input: SetModLogsAccessInput!): SetModLogsAccessPayload
1310
1311# Set a user's mod view page tutorial seen state & time.
1312setModViewSettings(input: SetModViewSettingsInput!): SetModViewSettingsPayload
1313
1314# setNotificationSetting allows a user to set a notification setting.
1315setNotificationSetting(
1316input: SetNotificationSettingInput!
1317): SetNotificationSettingPayload
1318
1319# setOverwatchLeagueTeamPreference allows a user to set their preferred Overwatch
1320# team.
1321setOverwatchLeagueTeamPreference(
1322input: SetOverwatchLeagueTeamPreferenceInput!
1323): SetOverwatchLeagueTeamPreferencePayload
1324
1325# Set a user's preferred language tag.
1326setPreferredLanguageTag(
1327input: SetPreferredLanguageTagInput!
1328): SetPreferredLanguageTagPayload
1329
1330# Set radio track information currently being played.
1331setRadioCurrentlyPlaying(
1332input: SetRadioCurrentlyPlayingInput!
1333): SetRadioCurrentlyPlayingPayload
1334
1335# Set a user's readable chat colors UI setting.
1336setReadableChatColorsEnabled(
1337input: SetReadableChatColorsEnabledInput!
1338): SetReadableChatColorsEnabledPayload
1339
1340# setResourceRestriction can create or update a restriction on a resource.
1341setResourceRestriction(
1342input: SetResourceRestrictionInput!
1343): SetResourceRestrictionPayload
1344
1345# setScheduleReminder toggles on or off a user's set reminder for a given
1346# scheduled event.
1347setScheduleReminder(input: SetScheduleReminderInput!): SetScheduleReminderPayload
1348
1349# setSessionStatus sets the user's status for this session, which influences how
1350# they appear ("online", "idle",
1351# "watching SnarfyBobo") to friends and related users. To maintain a session
1352# status, setSessionStatus needs to be sent
1353# periodically. The amount of time your application should wait between these
1354# status heartbeats is included in the
1355# response payload.
1356setSessionStatus(input: SetSessionStatusInput!): SetSessionStatusPayload
1357
1358# Set the ID of the primary player in a squad stream that the user currently has
1359# in the primary position.
1360setSquadStreamPrimaryPlayer(
1361input: SetSquadStreamPrimaryPlayerInput!
1362): SetSquadStreamPrimaryPlayerPayload
1363
1364# setUnbanRequestsSettings allows a user to set their channel's unban requests
1365# settings.
1366setUnbanRequestsSettings(
1367input: SetUnbanRequestsSettingsInput!
1368): SetUnbanRequestsSettingsPayload
1369
1370# Set user's country of residence.
1371setUserResidence(input: SetUserResidenceInput!): SetUserResidencePayload
1372
1373# Spend Twitch Prime monthly subscription credit.
1374spendSubscriptionCredit(
1375input: SpendSubscriptionCreditInput!
1376): SpendSubscriptionCreditPayload
1377
1378# Start a new ad break.
1379startAd(input: StartAdInput!): StartAdPayload
1380
1381# startBounty allows a user to start a bounty for tracking (e.g. track the viewers
1382# CCU for meeting the bounty's requirements).
1383# If the user has not provided a title or met the other requirements to start the
1384# bounty, it will return an error.
1385startBounty(input: StartBountyInput!): StartBountyPayload
1386
1387# Starts a cloud broadcast.
1388startCloudBroadcast(input: StartCloudBroadcastInput!): StartCloudBroadcastPayload
1389
1390# Start a new payout onboarding workflow.
1391startPayoutOnboardingWorkflow(
1392input: StartPayoutOnboardingWorkflowInput!
1393): StartPayoutOnboardingWorkflowPayload
1394
1395# Start a Prime Video Watch Party.
1396startWatchParty(input: StartWatchPartyInput!): StartWatchPartyPayload
1397
1398# stopBounty allows a user to stop tracking progress for a bounty.
1399stopBounty(input: StopBountyInput!): StopBountyPayload
1400
1401# Stops a cloud broadcast.
1402stopCloudBroadcast(input: StopCloudBroadcastInput!): StopCloudBroadcastPayload
1403
1404# Stop a Prime Video Watch Party.
1405stopWatchParty(input: StopWatchPartyInput!): StopWatchPartyPayload
1406
1407# Submit CSAT (customer satisfaction) feedback.
1408submitCSATFeedback(input: SubmitCSATFeedbackInput!): SubmitCSATFeedbackPayload
1409
1410# Submit a new emote prefix for a given channel. Each channel has a single prefix.
1411# Submitting more than once overrides the previously set prefix.
1412submitEmotePrefix(input: SubmitEmotePrefixInput!): SubmitEmotePrefixPayload
1413
1414# Submit a new emoticon prefix for a given channel. Each channel has a single
1415# prefix. Submitting
1416# more than once simply overrides the previously set prefix and putting it in a
1417# pending state.
1418submitEmoticonPrefix(
1419input: SubmitEmoticonPrefixInput!
1420): SubmitEmoticonPrefixPayload @deprecated( reason: "Use 'submitEmotePrefix' instead" )
1421
1422# Submit feedback for a Twitch extension.
1423submitExtensionFeedback(
1424input: SubmitExtensionFeedbackInput!
1425): SubmitExtensionFeedbackPayload
1426
1427# Swap competition lobby participants within a competition phase.
1428swapCompetitionLobbyParticipants(
1429input: SwapCompetitionLobbyParticipantsInput!
1430): SwapCompetitionLobbyParticipantsPayload
1431
1432# Syncs the current game data with the game data stored by the
1433# DropsManagementService. The DropsManagementService
1434# purposefully does not autosync when a Game is updated so that a change to the
1435# Game's account link client ID
1436# doesn't get overwritten without running this command.
1437syncGameOnDropCampaign(
1438input: SyncGameOnDropCampaignInput!
1439): SyncGameOnDropCampaignPayload
1440
1441# Terminates the poll with the given poll id.
1442terminatePoll(input: TerminatePollInput!): TerminatePollPayload
1443
1444# Terminates the current poll in a channel.
1445terminatePollInChannel(
1446input: TerminatePollInChannelInput!
1447): TerminatePollInChannelPayload
1448
1449# toggleRitualsEnabled allows a user to toggle the rituals feature for their
1450# channel.
1451toggleRitualsEnabled(input: ToggleRitualsEnabledInput!): ToggleRitualsEnabledPayload
1452
1453# Transitions the state for an existing extension.
1454# Only allowed for the owner of the extension.
1455transitionExtensionState(
1456input: TransitionExtensionStateInput!
1457): TransitionExtensionStatePayload
1458
1459# Removes a ban imposed on a user for a specified chat room.
1460unbanUserFromChatRoom(input: UnbanUserFromChatRoomInput!): UnbanUserFromChatRoomPayload
1461
1462# Removes block from target user.
1463unblockUser(input: UnblockUserInput!): UnblockUserPayload
1464
1465# undoRecommendationFeedback allows a user to removes a single piece of feedback.
1466undoRecommendationFeedback(
1467input: UndoRecommendationFeedbackInput!
1468): UndoRecommendationFeedbackPayload
1469
1470# unfollowGame allows a user to unfollow a game.
1471unfollowGame(input: UnfollowGameInput!): UnfollowGamePayload
1472
1473# unfollowUser destroys the follow relationship between the authenticated user and
1474# the target user.
1475unfollowUser(input: UnfollowUserInput!): UnfollowUserPayload
1476
1477# unfriendUser destroys a friend relationship from the target user to the
1478# authenticated user.
1479unfriendUser(input: UnfriendUserInput!): UnfriendUserPayload
1480
1481# Unhost from a channel.
1482unhost(input: UnhostInput!): UnhostPayload
1483
1484# Uninstall an extension from a specific channel.
1485uninstallExtension(input: UninstallExtensionInput!): UninstallExtensionPayload
1486
1487# Unlink an authenticated user's amazon connection.
1488unlinkAmazonConnection(
1489input: UnlinkAmazonConnectionInput!
1490): UnlinkAmazonConnectionPayload
1491
1492# Unlink a user's account connection to Riot.
1493unlinkRiotConnection(input: UnlinkRiotConnectionInput!): UnlinkRiotConnectionPayload
1494
1495# Unlink an SSO app from a user's account.
1496unlinkSSO(
1497input: UnlinkSSOInput!
1498): UnlinkSSOPayload @deprecated( reason: "Service has been shutdown" )
1499
1500# Unlock a chosen modified subscriber emote using Community Points.
1501unlockChosenModifiedSubscriberEmote(
1502input: UnlockChosenModifiedSubscriberEmoteInput!
1503): UnlockChosenModifiedSubscriberEmotePayload
1504
1505# Unlock a chosen subscriber emote using Community Points.
1506unlockChosenSubscriberEmote(
1507input: UnlockChosenSubscriberEmoteInput!
1508): UnlockChosenSubscriberEmotePayload
1509
1510# Unlock a random subscriber emote using Community Points.
1511unlockRandomSubscriberEmote(
1512input: UnlockRandomSubscriberEmoteInput!
1513): UnlockRandomSubscriberEmotePayload
1514
1515# Remove moderator status from a user in a channel.
1516unmodUser(input: UnmodUserInput!): UnmodUserPayload
1517
1518# unsetHypeTrainConfig allows a user to unset the channel's custom hype train
1519# configurations.
1520unsetHypeTrainConfig(input: UnsetHypeTrainConfigInput!): UnsetHypeTrainConfigPayload
1521
1522# unsubscribeEmail unsubscribes a given user from a given email campaign.
1523unsubscribeEmail(input: UnsubscribeEmailInput!): UnsubscribeEmailPayload
1524
1525# Updates a user's ad settings for their channel.
1526updateAdProperties(input: UpdateAdPropertiesInput!): UpdateAdPropertiesPayload
1527
1528# Updates all a channels vidoes to the provided viewability.
1529updateAllChannelVideosViewability(
1530input: UpdateAllChannelVideosViewabilityInput!
1531): UpdateAllChannelVideosViewabilityPayload
1532
1533# Updates all of a user's whisper threads.
1534updateAllWhisperThreads(
1535input: UpdateAllWhisperThreadsInput!
1536): UpdateAllWhisperThreadsPayload
1537
1538# Set individual automod categories (i.e. set identity to level 3 but profanity to
1539# 0).
1540updateAutoModLevels(input: UpdateAutoModLevelsInput!): UpdateAutoModLevelsPayload
1541
1542# Set individual automod categories (i.e. set identity to level 3 but profanity to
1543# 0) - based on Sift categories, to be deprecated.
1544updateAutoModProperties(
1545input: UpdateAutoModPropertiesInput!
1546): UpdateAutoModPropertiesPayload
1547
1548# Update a user's autohost settings.
1549updateAutohostSettings(
1550input: UpdateAutohostSettingsInput!
1551): UpdateAutohostSettingsPayload
1552
1553# Updates bits badge tier notification.
1554updateBitsBadgeTierNotification(
1555input: UpdateBitsBadgeTierNotificationInput!
1556): UpdateBitsBadgeTierNotificationPayload
1557
1558# Updates bits badge tiers.
1559updateBitsBadgeTiers(input: UpdateBitsBadgeTiersInput!): UpdateBitsBadgeTiersPayload
1560
1561# Updates boost settings.
1562updateBoostSettings(input: UpdateBoostSettingsInput!): UpdateBoostSettingsPayload
1563
1564# updateBroadcastSettings allows the user to update their broadcast setting.
1565updateBroadcastSettings(
1566input: UpdateBroadcastSettingsInput!
1567): UpdateBroadcastSettingsPayload
1568
1569# Update a channels celebration.
1570updateCelebration(input: UpdateCelebrationInput!): UpdateCelebrationPayload
1571
1572# Update a channels celebration config.
1573updateCelebrationConfig(
1574input: UpdateCelebrationConfigInput!
1575): UpdateCelebrationConfigPayload
1576
1577# Update a channel's celebration product config.
1578updateCelebrationProductConfig(
1579input: UpdateCelebrationProductConfigInput!
1580): UpdateCelebrationProductConfigPayload
1581
1582# Update a user's celebration user settings.
1583updateCelebrationUserSettings(
1584input: UpdateCelebrationUserSettingsInput!
1585): UpdateCelebrationUserSettingsPayload
1586
1587# updateChangelogReadTime marks the changelog as read for a user.
1588updateChangelogReadTime: UpdateChangelogReadTimePayload
1589
1590# updateChanletContentAttributes allows users to make changes to the multi-view
1591# content attributes on a chanlet.
1592updateChanletContentAttributes(
1593input: UpdateChanletContentAttributesInput!
1594): UpdateChanletContentAttributesPayload
1595
1596# updateChannelClipsSetting allows a channel owner to enable/disable creation
1597# of Clips on their channel.
1598updateChannelClipsSetting(
1599input: UpdateChannelClipsSettingInput!
1600): UpdateChannelClipsSettingPayload
1601
1602# updateChannelHomePreferences updates a streamer's channel home preferences.
1603updateChannelHomePreferences(
1604input: UpdateChannelHomePreferencesInput!
1605): UpdateChannelHomePreferencesPayload
1606
1607# Update a channel's Prediction Settings.
1608updateChannelPredictionSettings(
1609input: UpdateChannelPredictionSettingsInput!
1610): UpdateChannelPredictionSettingsPayload
1611
1612# Updates a user's chat color.
1613updateChatColor(input: UpdateChatColorInput!): UpdateChatColorPayload
1614
1615# Set different chat settings (i.e. disable globalBannedWordsOptOut).
1616updateChatSettings(input: UpdateChatSettingsInput!): UpdateChatSettingsPayload
1617
1618# Update the user's partner settings regarding bits.
1619updateCheerPartnerSettings(
1620input: UpdateCheerPartnerSettingsInput!
1621): UpdateCheerPartnerSettingsPayload
1622
1623# Updates the image assets for a broadcaster's particular cheermote tier.
1624updateCheermoteTier(input: UpdateCheermoteTierInput!): UpdateCheermoteTierPayload
1625
1626# updateClip allows a user to update the metadata of a clip.
1627updateClip(input: UpdateClipInput!): UpdateClipPayload
1628
1629# updateClipViewCount allows a user to increment the viewcount of a clip.
1630updateClipViewCount(
1631input: UpdateClipViewCountInput!
1632): UpdateClipViewCountPayload @deprecated( reason: "Will eventually be replaced by different viewcounting method" )
1633
1634# updateCollection performs an update on the collection with the provided ID and
1635# updated attributes.
1636updateCollection(input: UpdateCollectionInput!): UpdateCollectionPayload
1637
1638# Update an automatic Community Points reward in a channel.
1639updateCommunityPointsAutomaticReward(
1640input: UpdateCommunityPointsAutomaticRewardInput!
1641): UpdateCommunityPointsAutomaticRewardPayload
1642
1643# Update a channel's Community Points channel settings.
1644updateCommunityPointsChannelSettings(
1645input: UpdateCommunityPointsChannelSettingsInput!
1646): UpdateCommunityPointsChannelSettingsPayload
1647
1648# updateCommunityPointsCommunityGoal updates a Community Points Community Goal.
1649updateCommunityPointsCommunityGoal(
1650input: UpdateCommunityPointsCommunityGoalInput!
1651): UpdateCommunityPointsCommunityGoalPayload
1652
1653# Update a custom Community Points reward in a channel.
1654updateCommunityPointsCustomReward(
1655input: UpdateCommunityPointsCustomRewardInput!
1656): UpdateCommunityPointsCustomRewardPayload
1657
1658# Update the status of a Community Points redemption (for example, from
1659# unfulfilled to fulfilled).
1660updateCommunityPointsCustomRewardRedemptionStatus(
1661input: UpdateCommunityPointsCustomRewardRedemptionStatusInput!
1662): UpdateCommunityPointsCustomRewardRedemptionStatusPayload
1663
1664# Update the status of all Community Points redemptions for a channel.
1665updateCommunityPointsCustomRewardRedemptionStatusesByChannel(
1666input: UpdateCommunityPointsCustomRewardRedemptionStatusesByChannelInput!
1667): UpdateCommunityPointsCustomRewardRedemptionStatusesByChannelPayload
1668
1669# Update the status of the Community Points redemptions from the provided list.
1670updateCommunityPointsCustomRewardRedemptionStatusesByRedemptions(
1671input: UpdateCommunityPointsCustomRewardRedemptionStatusesByRedemptionsInput!
1672): UpdateCommunityPointsCustomRewardRedemptionStatusesByRedemptionsPayload
1673
1674# Update the status of all Community Points redemptions for a reward.
1675updateCommunityPointsCustomRewardRedemptionStatusesByReward(
1676input: UpdateCommunityPointsCustomRewardRedemptionStatusesByRewardInput!
1677): UpdateCommunityPointsCustomRewardRedemptionStatusesByRewardPayload
1678
1679# Allows users to sign up for or remove themselves from the Community Points early
1680# access program.
1681updateCommunityPointsEarlyAccessSettings(
1682input: UpdateCommunityPointsEarlyAccessSettingsInput!
1683): UpdateCommunityPointsEarlyAccessSettingsPayload @deprecated( reason: "Early access period is over." )
1684
1685# Update the last viewed timestamp of a user for Community Points content.
1686updateCommunityPointsLastViewedContent(
1687input: UpdateCommunityPointsLastViewedContentInput!
1688): UpdateCommunityPointsLastViewedContentPayload
1689
1690# Update an automatic Community Points reward cost acknowledgements.
1691updateCommunityPointsSmartCostsAcknowledgements(
1692input: UpdateCommunityPointsSmartCostsAcknowledgementsInput!
1693): UpdateCommunityPointsSmartCostsAcknowledgementsPayload
1694
1695# Update Competition.
1696updateCompetition(input: UpdateCompetitionInput!): UpdateCompetitionPayload
1697
1698# Update CompetitionPlayer in a competition.
1699updateCompetitionPlayer(
1700input: UpdateCompetitionPlayerInput!
1701): UpdateCompetitionPlayerPayload
1702
1703# Update a Team in a Competition.
1704updateCompetitionTeam(input: UpdateCompetitionTeamInput!): UpdateCompetitionTeamPayload
1705
1706# Update a consent status or create a new consent status.
1707updateConsent(input: UpdateConsentInput!): UpdateConsentPayload
1708
1709# updateContentTags updates the tags specified and associates it with the piece of
1710# content specified.
1711updateContentTags(
1712input: UpdateContentTagsInput!
1713): UpdateContentTagsPayload @deprecated( reason: "Use setContentTags instead" )
1714
1715# updateDropBenefit updates a benefit owned by an organization. The benefit can be
1716# used in drop campaigns.
1717updateDropBenefit(input: UpdateDropBenefitInput!): UpdateDropBenefitPayload
1718
1719# updateDropBenefitOnDrop sets a benefit on a drop and how often that benefit can
1720# be claimed.
1721updateDropBenefitOnDrop(
1722input: UpdateDropBenefitOnDropInput!
1723): UpdateDropBenefitOnDropPayload
1724
1725# updateDropPreconditions updates the drops that must be claimed before a drop can
1726# be claimed.
1727updateDropPreconditions(
1728input: UpdateDropPreconditionsInput!
1729): UpdateDropPreconditionsPayload
1730
1731# updateDropsOptOutStatus allows the user to update their drops opt-out status.
1732updateDropsOptOutStatus(
1733input: UpdateDropsOptOutStatusInput!
1734): UpdateDropsOptOutStatusPayload
1735
1736# updateEmoteOrders allows a broadcaster to reorder the emotes within the emote
1737# groups they own.
1738updateEmoteOrders(input: UpdateEmoteOrdersInput!): UpdateEmoteOrdersPayload
1739
1740# updateExtensionDiscoveryData allows a user to update the discovery data for an
1741# extension.
1742updateExtensionDiscoveryData(
1743input: UpdateExtensionDiscoveryDataInput!
1744): UpdateExtensionDiscoveryDataPayload
1745
1746# updateExtensionManifest allows a user to update the manifest for an extension in
1747# development.
1748updateExtensionManifest(
1749input: UpdateExtensionManifestInput!
1750): UpdateExtensionManifestPayload @deprecated( reason: "Switching to saveExtensionManifest" )
1751
1752# updateHypeTrainConfig allows a user to update the channel's hype train
1753# configurations.
1754updateHypeTrainConfig(input: UpdateHypeTrainConfigInput!): UpdateHypeTrainConfigPayload
1755
1756# Changes the user's activity sharing setting. A user's activity is one part of
1757# their status.
1758updateIsSharingActivity(
1759input: UpdateIsSharingActivityInput!
1760): UpdateIsSharingActivityPayload
1761
1762# Exchanges an LWA token for an Amazon OAuth token.
1763updateLWAToken(input: UpdateLWATokenInput!): UpdateLWATokenPayload
1764
1765# Update the user's partner settings regarding leaderboards.
1766updateLeaderboardSettings(
1767input: UpdateLeaderboardSettingsInput!
1768): UpdateLeaderboardSettingsPayload
1769
1770# Changes the user's activity sharing setting. A user's activity is one part of
1771# their status.
1772updateLiveUpNotification(
1773input: UpdateLiveUpNotificationInput!
1774): UpdateLiveUpNotificationPayload
1775
1776# Updates a lobby participant who is a competition player's or competition team's
1777# score.
1778updateLobbyParticipantScore(
1779input: UpdateLobbyParticipantScoreInput!
1780): UpdateLobbyParticipantScorePayload
1781
1782# Updates a Mosaic layout with the specified id for the current user.
1783updateDashboardViewMosaicLayout(
1784input: UpdateDashboardViewMosaicLayoutInput!
1785): UpdateDashboardViewMosaicLayoutPayload
1786
1787# Modifies multi-view content attributes.
1788updateMultiviewContentAttributes(
1789input: UpdateMultiviewContentAttributesInput!
1790): UpdateMultiviewContentAttributesPayload
1791
1792# updateOnboardingSkippedChannels updates skipped channel IDs during onboarding
1793# for a given user.
1794updateOnboardingSkippedChannels(
1795input: UpdateOnboardingSkippedChannelsInput!
1796): UpdateOnboardingSkippedChannelsPayload @deprecated( reason: "This feature is retired" )
1797
1798# updateOrganizationMemberRole updates the role of an organization member (Twitch
1799# Developers).
1800updateOrganizationMemberRole(
1801input: UpdateOrganizationMemberRoleInput!
1802): UpdateOrganizationMemberRolePayload
1803
1804# updateOwnerChanletAttributes updates/creates a new set of owner chanlet
1805# attributes for a Channel.
1806updateOwnerChanletAttributes(
1807input: UpdateOwnerChanletAttributesInput!
1808): UpdateOwnerChanletAttributesPayload
1809
1810# updatePanel updates the data for a given panel.
1811updatePanel(input: UpdatePanelInput!): UpdatePanelPayload
1812
1813# Starts the process for associating a phone number to a twitch account. Requires
1814# sudo authentication.
1815# A one time password (valid for 10 minutes) will be sent via SMS to the phone
1816# number provided. The one time password will need to be verified via
1817# updatePhoneNumberConfirmation to complete the update.
1818updatePhoneNumber(input: UpdatePhoneNumberInput!): UpdatePhoneNumberPayload
1819
1820# Completes the process for associating a phone number to a twitch account.
1821# Requires sudo authentication.
1822# The one time password issued using updatePhoneNumber will be verified to make
1823# sure user contols the phone number.
1824updatePhoneNumberConfirmation(
1825input: UpdatePhoneNumberConfirmationInput!
1826): UpdatePhoneNumberConfirmationPayload
1827
1828# updatePrimeOfferStatus allows a user to update their status in respect to an
1829# offer. (e.g. UNSEEN, SEEN, CLAIMED).
1830updatePrimeOfferStatus(
1831input: UpdatePrimeOfferStatusInput!
1832): UpdatePrimeOfferStatusPayload
1833
1834# updatePrimeSettings allows the user to enable or disable chat notifications when
1835# spending a Prime Credit,
1836# and allows the user to set the type of Smilies (Turbos, Robots, or Monkeys) they
1837# want for Prime/Turbo Emoticons.
1838updatePrimeSettings(input: UpdatePrimeSettingsInput!): UpdatePrimeSettingsPayload
1839
1840# Update a user's raid settings.
1841updateRaidSettings(input: UpdateRaidSettingsInput!): UpdateRaidSettingsPayload
1842
1843# Updates an existing chatroom.
1844updateRoom(
1845input: UpdateRoomInput!
1846): UpdateRoomPayload @deprecated( reason: "No longer supported" )
1847
1848# Updates the room modes (slow mode, emotes only mode, etc.) for the room.
1849updateRoomModes(
1850input: UpdateRoomModesInput!
1851): UpdateRoomModesPayload @deprecated( reason: "No longer supported" )
1852
1853# Update's a user's room view for a chatroom.
1854updateRoomView(
1855input: UpdateRoomViewInput!
1856): UpdateRoomViewPayload @deprecated( reason: "No longer supported" )
1857
1858# Update a schedule segment.
1859updateScheduleSegment(input: UpdateScheduleSegmentInput!): UpdateScheduleSegmentPayload
1860
1861# UpdateSeenCreatorOnboardingContent updates the list of streamer onboarding
1862# content that a user has seen.
1863updateSeenCreatorOnboardingContent(
1864input: UpdateSeenCreatorOnboardingContentInput!
1865): UpdateSeenCreatorOnboardingContentPayload
1866
1867# updateSocialMedia updates an existing social media item for a Channel.
1868updateSocialMedia(input: UpdateSocialMediaInput!): UpdateSocialMediaPayload
1869
1870# updateSquadInvitePolicy allows a broadcaster to update their squad stream invite
1871# policy.
1872updateSquadInvitePolicy(
1873input: UpdateSquadInvitePolicyInput!
1874): UpdateSquadInvitePolicyPayload
1875
1876# updateSquadStream allows an owner of a squad stream to update the squad stream.
1877updateSquadStream(input: UpdateSquadStreamInput!): UpdateSquadStreamPayload
1878
1879# updateStucco allows a user to update a stucco (that is currently not active).
1880updateStucco(input: UpdateStuccoInput!): UpdateStuccoPayload
1881
1882# updateStuccoPack allows the updating of a channel's stucco pack. (activating
1883# stuccos).
1884updateStuccoPack(input: UpdateStuccoPackInput!): UpdateStuccoPackPayload
1885
1886# updateSubscriptionProduct allows a user to update their subscription product
1887# settings.
1888updateSubscriptionProduct(
1889input: UpdateSubscriptionProductInput!
1890): UpdateSubscriptionProductPayload
1891
1892# updateUser updates a user's displayname, description, email or delete a phone
1893# number.
1894updateUser(input: UpdateUserInput!): UpdateUserPayload
1895
1896# Updates a user's creator colors.
1897updateUserColors(input: UpdateUserColorsInput!): UpdateUserColorsPayload
1898
1899# Set a user's privacy preference for registration date.
1900updateUserCreateDateHidden(
1901input: UpdateUserCreateDateHiddenInput!
1902): UpdateUserCreateDateHiddenPayload
1903
1904# Set a user's directory hidden field.
1905updateUserDirectoryHidden(
1906input: UpdateUserDirectoryHiddenInput!
1907): UpdateUserDirectoryHiddenPayload
1908
1909# Set a user's email reuse field.
1910updateUserEmailReusable(
1911input: UpdateUserEmailReusableInput!
1912): UpdateUserEmailReusablePayload
1913
1914# updateUserIsEmailRevertSuccess sets/resets a user's Email revert success flag.
1915updateUserIsEmailRevertSuccess(
1916input: UpdateUserIsEmailRevertSuccessInput!
1917): UpdateUserIsEmailRevertSuccessPayload
1918
1919# Update a user's Prediction Settings.
1920updateUserPredictionSettings(
1921input: UpdateUserPredictionSettingsInput!
1922): UpdateUserPredictionSettingsPayload
1923
1924# updateUserSubscriptionSettings updates the subscription preferences for the
1925# authenticated user.
1926updateUserSubscriptionSettings(
1927input: UpdateUserSubscriptionSettingsInput!
1928): UpdateUserSubscriptionSettingsPayload
1929
1930# updateUserTeamMembership updates the team membership preferences for target
1931# user.
1932updateUserTeamMembership(
1933input: UpdateUserTeamMembershipInput!
1934): UpdateUserTeamMembershipPayload
1935
1936# updateUserVideoShelves adds/removes/reorders for a user's video shelves.
1937updateUserVideoShelves(
1938input: UpdateUserVideoShelvesInput!
1939): UpdateUserVideoShelvesPayload
1940
1941# updateUserViewedVideo updates a resume watching entry for a specified user and
1942# video.
1943updateUserViewedVideo(input: UpdateUserViewedVideoInput!): UpdateUserViewedVideoPayload
1944
1945# updateVideo updates a video identified by provided video ID.
1946updateVideo(input: UpdateVideoInput!): UpdateVideoPayload
1947
1948# updateVideoComment updates a video comment identified by provided comment ID.
1949updateVideoComment(input: UpdateVideoCommentInput!): UpdateVideoCommentPayload
1950
1951# updateVideoStreamSettings updates the broadcaster's video stream settings such
1952# as latency mode.
1953updateVideoStreamSettings(
1954input: UpdateVideoStreamSettingsInput!
1955): UpdateVideoStreamSettingsPayload
1956
1957# UpdateVideosViewability updates videos to being published or unpublished.
1958updateVideosViewability(
1959input: UpdateVideosViewabilityInput!
1960): UpdateVideosViewabilityPayload
1961
1962# Changes the user's visibility setting. This is an account-level setting that
1963# will cause the user's availability to
1964# appear differently to other users, despite what sessions are reporting. See the
1965# VisibilityInput enum for details on
1966# the effects of each value.
1967#
1968# Because this is an account-level setting, it should only be used in response to
1969# the user expressing clear intention
1970# to change their visibility. Setting a status for an individual session should be
1971# done using setSessionStatus.
1972updateVisibility(input: UpdateVisibilityInput!): UpdateVisibilityPayload
1973
1974# Updates Whisper settings for the authenticated user.
1975updateWhisperSettings(input: UpdateWhisperSettingsInput!): UpdateWhisperSettingsPayload
1976
1977# Updates a whisper thread.
1978updateWhisperThread(input: UpdateWhisperThreadInput!): UpdateWhisperThreadPayload
1979
1980# uploadCompetitionImage generates a url for a user to upload an image to for a
1981# competition.
1982uploadCompetitionImage(
1983input: UploadCompetitionImageInput!
1984): UploadCompetitionImagePayload
1985
1986# Uses a chat notification token.
1987useChatNotificationToken(
1988input: UseChatNotificationTokenInput!
1989): UseChatNotificationTokenPayload
1990
1991# validateVerificationCode validates a given code and sets the address to verified
1992# if it matches.
1993validateVerificationCode(
1994input: ValidateVerificationCodeInput!
1995): ValidateVerificationCodePayload
1996
1997# verifyContactMethod verifies a user contact method from an opaque ID.
1998verifyContactMethod(input: VerifyContactMethodInput!): VerifyContactMethodPayload
1999
2000# verifyOneTimePassword verifies a one time password for a user for
2001# authentication. Requires sudo authentication.
2002verifyOneTimePassword(input: VerifyOneTimePasswordInput!): VerifyOneTimePasswordPayload
2003
2004# verifyRewardedVideoEligibilityCaptcha verifies a users captcha with the rewarded
2005# video system.
2006verifyRewardedVideoEligibilityCaptcha(
2007input: VerifyRewardedVideoEligibilityCaptchaInput!
2008): VerifyRewardedVideoEligibilityCaptchaPayload
2009
2010# viewedNotifications updates when the authenticated user last saw onsite
2011# notifications.
2012viewedNotifications: ViewedNotificationsPayload
2013
2014# visitStreamManager updates when the authenticated user visits their stream
2015# manager for the first time.
2016visitStreamManager(input: VisitStreamManagerInput!): VisitStreamManagerPayload
2017
2018# Casts a vote for a specific choice in an ad poll.
2019voteInAdPoll(input: VoteInAdPollInput!): VoteInAdPollPayload
2020
2021# Casts a vote for a specific choice in a poll.
2022voteInPoll(input: VoteInPollInput!): VoteInPollPayload
2023
2024# Casts a vote for a specific choice in a poll, by index and channelID.
2025voteInPollByChoiceIndex(
2026input: VoteInPollByChoiceIndexInput!
2027): VoteInPollByChoiceIndexPayload
2028
2029}

link Required by

This element is not required by anyone