Skip to main content
POST
cURL

Headers

x-api-key
string<uuid>
required

Your community API key

Body

application/json
name
string
required

Quest name.

Maximum string length: 48
shortDescription
string
required

Quest intro (plain text only).

Maximum string length: 256
fullDescription
string
required

Quest instructions (supports markdown).

Maximum string length: 4096
recurrence
enum<string>
required

Quest recurrence type.

Available options:
ONCE,
DAILY,
WEEKLY,
MONTHLY,
CUSTOM
visibility
enum<string>
required

Quest visibility type.

Available options:
PRIVATE,
PUBLIC,
SHARED
tasks
(API · object | Discord Account Age · object | Discord Server Roles · object | Discord Server Tag · object | Discord Users · object | File Upload · object | NFT Balance · object | Numeric Input · object | Points Balance · object | Points Tip · object | Poll Input · object | Quest Streak · object | Steam Account Age · object | Steam Account Level · object | Steam Game Achievements · object | Steam Game Completion · object | Steam Game Ownership · object | Steam Game Playtime · object | Token Swap · object | Text Input · object | Token Tip · object | Token Balance · object | Top.gg Discord Bot Vote · object | Top.gg Discord Server Vote · object | X Account Age · object | Follow X Account · object | X Account Followers · object | Subscribe X Account · object | Verified X Account · object | X Post Interaction · object | Create X Post · object | Wallet Input · object)[]
required

Quest tasks and requirements.

Maximum array length: 32
rewards
(Fixed · object | Random · object | Shared · object)[]
required

Rewards that can be obtained by completing the quest.

Maximum array length: 4
bannerUrl
string<uri> | null

Link to a banner image for the quest.

recurrenceInterval
number | null

Quest interval between rounds, or its duration for ONCE recurrence type.

Required range: 3600000 <= x <= 31536000000
maxIterations
integer | null

Maximum number of quest rounds.

Required range: 1 <= x <= 9007199254740991
maxIterationCompletions
integer | null

Maximum number of completions per quest round.

Required range: 1 <= x <= 9007199254740991
maxTotalCompletions
integer | null

Maximum number of total quest completions.

Required range: 1 <= x <= 9007199254740991
status
enum<string> | null
default:ACTIVE

Status to create the quest with.

Available options:
DRAFT,
ACTIVE
discordShareChannelId
string | null

Discord channel in your server where the quest will be shared if created with ACTIVE status. If not provided, quest will be shared in one of the default channels configured via dashboard.

Pattern: ^\d{16,20}$
discordPingRoleIds
string[] | null

Discord roles in your server to ping when a quest is activated or resets. If not provided, default roles configured via dashboard will be pinged.

Maximum array length: 16
Pattern: ^\d{16,20}$

Response

200 - application/json

Quest has been created

id
string
required

Unique quest ID.

status
enum<string>
required

Quest status.

Available options:
DRAFT,
TEMPLATE,
ACTIVE,
PAUSED,
REVIEW,
ENDED,
ARCHIVED
name
string
required

Quest name.

Maximum string length: 48
shortDescription
string
required

Quest intro (plain text only).

Maximum string length: 256
fullDescription
string
required

Quest instructions (supports markdown).

Maximum string length: 4096
createdAt
number
required

Quest creation UNIX timestamp.

recurrence
enum<string>
required

Quest recurrence type.

Available options:
ONCE,
DAILY,
WEEKLY,
MONTHLY,
CUSTOM
visibility
enum<string>
required

Quest visibility type.

Available options:
PRIVATE,
PUBLIC,
SHARED
iteration
integer
required

Current quest round.

Required range: 1 <= x <= 9007199254740991
iterationCompletions
number[]
required

Quest completions per iteration.

totalCompletionCount
number
required

Total quest completions count.

tasks
object[]
required

Quest tasks and requirements.

Maximum array length: 32
communityId
string
required

ID of the community this quest belongs to

rewards
(Fixed · object | Random · object | Shared · object)[]
required

Rewards that can be obtained by completing the quest.

Maximum array length: 4
versionId
string | null

ID of the latest editable quest version.

creatorId
string | null

ID of the user who created this quest.

bannerUrl
string<uri> | null

Link to a banner image for the quest.

startTime
number | null

Quest start time UNIX timestamp.

endTime
number | null

Quest end time UNIX timestamp.

recurrenceInterval
number | null

Quest interval between rounds, or its duration for ONCE recurrence type.

Required range: 3600000 <= x <= 31536000000
nextIterationAt
number | null

Next quest round start time UNIX timestamp.

maxIterations
integer | null

Maximum number of quest rounds.

Required range: 1 <= x <= 9007199254740991
maxIterationCompletions
integer | null

Maximum number of completions per quest round.

Required range: 1 <= x <= 9007199254740991
maxAllowedStreakGap
integer

Maximum number of missed quest rounds that still count toward a streak.

Required range: 0 <= x <= 9007199254740991
maxTotalCompletions
integer | null

Maximum number of total quest completions.

Required range: 1 <= x <= 9007199254740991
discordShareChannelId
string | null

Discord channel in your server where the quest is shared.

Pattern: ^\d{16,20}$
discordPingRoleIds
string[] | null

Discord roles in your server to ping when a quest is activated or resets.

Maximum array length: 16
Pattern: ^\d{16,20}$