INPUT_OBJECT

CreateCompetitionInput

Create a Competition.

link GraphQL Schema definition

1input CreateCompetitionInput {
4
2# Banner image for the competition event page.
3bannerImageURL: String
8
5# This is the amount of time (in minutes) available for participants to check-in
6# once competition startAt has passed.
7checkInDurationMinutes: Int!
11
9# Long form description of the competition.
10description: String
14
12# The time the competition is scheduled to end.
13endAt: Time!
18
15# The competition format type (i.e. enum values of LEADERBOARD, ROUND_ROBIN,
16# SINGLE_ELIM etc.).
17formatType: FormatType!
21
19# The game_id of the game being played in the competition.
20gameID: ID!
24
22# Primary artwork for the competition.
23imageURL: String
27
25# The required inputs for leaderboard format.
26leaderboardDetails: CreateCompetitionLeaderboardDetailsInput
30
28# The name of the competition.
29name: String!
33
31# Owner of the Competition, or filled in as user making the request.
32ownerID: ID
37
34# The participant-facing points of contact for the competition that only
35# registered players can see.
36participantOnlyContactInfo: CreateCompetitionContactInfoInput
40
38# The type of participant for the competition. e.g. SOLO, TEAM, ...
39participantType: CompetitionParticipantType!
44
41# Long form text block description that explains the prizing for the competition
42# and will be converted to Markdown client-side.
43prizeDescription: String
47
45# The public points of contact for the competition that anyone can see.
46publicContactInfo: CreateCompetitionContactInfoInput
50
48# The time the competition is scheduled to end registration.
49registrationEndAt: Time!
54
51# The maximum number of players in a REGISTERED state. A default value will be set
52# if none is provided.
53registrationLimit: Int
57
55# The type of a registration for the competition. e.g. OPEN, INVITATIONAL, ...
56registrationType: RegistrationType!
61
58# Long form text block description that explains the rules for the competition and
59# will be converted to Markdown client-side.
60rulesDescription: String
64
62# The time the competition is scheduled to start.
63startAt: Time!
67
65# The state the Competition. Defaults to the UPCOMING state if not specified.
66state: CompetitionState
71
68# The number of players within a single team entity. Must be 1 for solo-type
69# competitions.
70teamSize: Int!
74
72# Link URL to any additional terms and conditions.
73termsURL: String
75}