Client API
Documentation
API Reference
Mutation
joinCup企业
Join a cup with a set of players.Returns a JoinCupResponse!
Response
Arguments
Name
Description
input: JoinCupInput!
leaveCup企业
createCup企业
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.Returns a CreateCupResponse!
Response
Arguments
Name
Description
input: CreateCupInput!
editCup企业
Edit an existing cup.Returns a EditCupResponse!
Response
Arguments
Name
Description
input: EditCupInput!
startCup企业
Allows you to start a cup directly.Returns a StartCupResponse!
Response
Arguments
Name
Description
input: StartCupInput!
cancelCup企业
Allows you to cancel a cup.Returns a CancelCupResponse!
Response
Arguments
Name
Description
input: CancelCupInput!
joinLadder
Let user join a ladder.Returns a JoinLadderResponse!
Response
Arguments
Name
Description
input: JoinLadderInput!
leaveLadder
Let user leave a ladder.Returns a LeaveLadderResponse!
Response
Arguments
Name
Description
input: LeaveLadderInput!
joinLeaderboardCore
Let user join a leaderboard by ID. Note that only some leaderboards require the user joining explicitly to participate in the leaderboard.Returns a JoinLeaderboardResponse!
Response
Arguments
Name
Description
input: JoinLeaderboardInput!
leaveLeaderboardCore
Let user leave a leaderboard by ID.Returns a LeaveLeaderboardResponse!
Response
Arguments
Name
Description
input: LeaveLeaderboardInput!
joinMatchmakingQueueCore
Let a user join a matchmaking queue.Returns a JoinMatchmakingQueueResponse!
Response
Arguments
Name
Description
input: JoinMatchmakingQueueInput!
leaveMatchmakingQueueCore
Let a user leave a matchmaking queue.Returns a LeaveMatchmakingQueueResponse!
Response
Arguments
Name
Description
input: LeaveMatchmakingQueueInput!
acceptMatchmakingOfferCore
Let a user accept a matchmaking offer.
If enough players accept they will be part of the resulting competition.Returns a AcceptMatchmakingOfferResponse!
Response
Arguments
Name
Description
input: AcceptMatchmakingOfferInput!
declineMatchmakingOfferCore
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.Returns a DeclineMatchmakingOfferResponse!
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.Returns a DeactivateSubscriptionResponse!
Response
Arguments
Name
Description
input: DeactivateSubscriptionInput!
signupTournament
Let a user sign up to a tournament, putting them on the waiting list.Returns a SignupTournamentResponse!
Response
Arguments
Name
Description
input: SignupTournamentInput!
leaveTournament
Let a user leave a tournament.Returns a LeaveTournamentResponse!
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.Returns a ConfirmMatchParticipationResponse!
Response
Arguments
Name
Description
setTournamentPreSeed
Set pre-seeds for tournament lineups.Returns a SetTournamentPreSeedResponse!
Response
Arguments
Name
Description
input: SetTournamentPreSeedInput!