Challengermode
Home
Dashboard
Game Integration API
Client API
Auth API
Embeds

Client API

Mutation

joinCup
Entreprise

Join a cup with a set of players.

Response

Returns a JoinCupResponse!
@authorize(policy: PAT)@cost(weight: 10)

Arguments

Name
Description
input: JoinCupInput!

leaveCup
Entreprise

Leave a cup.

Response

Returns a LeaveCupResponse!
@authorize(policy: PAT)@cost(weight: 10)

Arguments

Name
Description
input: LeaveCupInput!

createCup
Entreprise

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

Returns a CreateCupResponse!
@authorize(policy: BOT|PAT)@cost(weight: 10)

Arguments

Name
Description
input: CreateCupInput!

editCup
Entreprise

Edit an existing cup.

Response

Returns a EditCupResponse!
@authorize(policy: BOT|PAT)@cost(weight: 10)

Arguments

Name
Description
input: EditCupInput!

startCup
Entreprise

Allows you to start a cup directly.

Response

Returns a StartCupResponse!
@authorize(policy: BOT|PAT)@cost(weight: 10)

Arguments

Name
Description
input: StartCupInput!

cancelCup
Entreprise

Allows you to cancel a cup.

Response

Returns a CancelCupResponse!
@authorize(policy: BOT|PAT)@cost(weight: 10)

Arguments

Name
Description
input: CancelCupInput!

joinLeaderboard
Central

Let user join a leaderboard by ID. Note that only some leaderboards require the user joining explicitly to participate in the leaderboard.

Response

Returns a JoinLeaderboardResponse!
@authorize(policy: PAT)@cost(weight: 10)

Arguments

Name
Description
input: JoinLeaderboardInput!

leaveLeaderboard
Central

Let user leave a leaderboard by ID.

Response

Returns a LeaveLeaderboardResponse!
@authorize(policy: PAT)@cost(weight: 10)

Arguments

Name
Description
input: LeaveLeaderboardInput!

joinMatchmakingQueue
Central

Let a user join a matchmaking queue.

Response

Returns a JoinMatchmakingQueueResponse!
@authorize(policy: PAT)@cost(weight: 10)

Arguments

Name
Description
input: JoinMatchmakingQueueInput!

leaveMatchmakingQueue
Central

Let a user leave a matchmaking queue.

Response

Returns a LeaveMatchmakingQueueResponse!
@authorize(policy: PAT)@cost(weight: 10)

Arguments

Name
Description
input: LeaveMatchmakingQueueInput!

acceptMatchmakingOffer
Central

Let a user accept a matchmaking offer. If enough players accept they will be part of the resulting competition.

Response

Returns a AcceptMatchmakingOfferResponse!
@authorize(policy: PAT)@cost(weight: 10)

Arguments

Name
Description
input: AcceptMatchmakingOfferInput!

declineMatchmakingOffer
Central

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

Returns a DeclineMatchmakingOfferResponse!
@authorize(policy: PAT)@cost(weight: 10)

Arguments

Name
Description
input: DeclineMatchmakingOfferInput!

addSubscriptionCorrectionCredit

Force add credit to a user's subscription.

Response

Returns a AddSubscriptionCorrectionCreditResponse!
@authorize(policy: BOT)@cost(weight: 10)

Arguments

deactivateSubscription

Force cancel renewal and immediately deactivate a subscription.

Response

Returns a DeactivateSubscriptionResponse!
@authorize(policy: BOT)@cost(weight: 10)

Arguments

Name
Description
input: DeactivateSubscriptionInput!

signupTournament

Let a user sign up to a tournament, putting them on the waiting list.

Response

Returns a SignupTournamentResponse!
@authorize(policy: PAT)@cost(weight: 10)

Arguments

Name
Description
input: SignupTournamentInput!

leaveTournament

Let a user leave a tournament.

Response

Returns a LeaveTournamentResponse!
@authorize(policy: PAT)@cost(weight: 10)

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.

Response

Returns a ConfirmTournamentParticipationResponse!
@authorize(policy: PAT)@cost(weight: 10)

Arguments

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

Returns a ConfirmMatchParticipationResponse!
@authorize(policy: PAT)@cost(weight: 10)

Arguments

Name
Description
input: ConfirmMatchParticipationInput!

setTournamentPreSeed

Set pre-seeds for tournament lineups.

Response

Returns a SetTournamentPreSeedResponse!
@authorize(policy: BOT|PAT)@cost(weight: 10)

Arguments

Name
Description
input: SetTournamentPreSeedInput!