Client API
Documentation
API Reference
Mutation
joinCup
Enterprise
Join a cup with a set of players.
Response
Arguments
Name
Description
input: JoinCupInput!
leaveCup
Enterprise
createCup
Enterprise
Creates a cup as a user or via a BOT user (recommended).
The cup can be hosted by a specific space if the user or BOT is a space admin.
Simple cups can be created directly using parameters, while complex setups can utilize a pre-created templates.
Response
Arguments
Name
Description
input: CreateCupInput!
editCup
Enterprise
Edit an existing cup.
Response
Arguments
Name
Description
input: EditCupInput!
startCup
Enterprise
Allows you to start a cup directly.
Response
Arguments
Name
Description
input: StartCupInput!
cancelCup
Enterprise
Allows you to cancel a cup.
Response
Arguments
Name
Description
input: CancelCupInput!
joinLadder
Deprecated
DeprecatedUse leaderboard mutations instead.
Let user join a ladder.
Arguments
Name
Description
input: JoinLadderInput!
leaveLadder
Deprecated
DeprecatedUse leaderboard mutations instead.
Let user leave a ladder.
Arguments
Name
Description
input: LeaveLadderInput!
joinLeaderboard
Core
Let user join a leaderboard by ID. Note that only some leaderboards require the user joining explicitly to participate in the leaderboard.
Response
Arguments
Name
Description
input: JoinLeaderboardInput!
leaveLeaderboard
Core
Let user leave a leaderboard by ID.
Response
Arguments
Name
Description
input: LeaveLeaderboardInput!
joinMatchmakingQueue
Core
Let a user join a matchmaking queue.
Response
Arguments
Name
Description
input: JoinMatchmakingQueueInput!
leaveMatchmakingQueue
Core
Let a user leave a matchmaking queue.
Response
Arguments
Name
Description
input: LeaveMatchmakingQueueInput!
acceptMatchmakingOffer
Core
Let a user accept a matchmaking offer.
If enough players accept they will be part of the resulting competition.
Response
Arguments
Name
Description
input: AcceptMatchmakingOfferInput!
declineMatchmakingOffer
Core
Let a user decline a matchmaking offer.
Declining an offer will not put them back into the matchmaking queue. If the user times out however, they will be put back into the queue automatically.
Response
Arguments
Name
Description
addSubscriptionCorrectionCredit
Force add credit to a user's subscription.
Arguments
Name
Description
deactivateSubscription
Force cancel renewal and immediately deactivate a subscription.
Response
Arguments
Name
Description
input: DeactivateSubscriptionInput!
signupTournament
Let a user sign up to a tournament, putting them on the waiting list.
Response
Arguments
Name
Description
input: SignupTournamentInput!
leaveTournament
Let a user leave a tournament.
Response
Arguments
Name
Description
input: LeaveTournamentInput!
confirmTournamentParticipation
Let a user confirm their participation in a tournament before the tournament starts. Players that don't confirm their participation will not play in the tournament.
Arguments
Name
Description
confirmMatchParticipation
Let a user confirm their participation in a tournament match. If the tournament is configured to require this step, failing to confirm participation will result in a walkover.
Response
Arguments
Name
Description
setTournamentPreSeed
Set pre-seeds for tournament lineups.
Response
Arguments
Name
Description
input: SetTournamentPreSeedInput!