Skip to main content
POST
Create a new challenge group

Authorizations

x-api-token
string
header
required

Headers

x-language
string

The language to update the challenge group in. This will update the challenge group's content for the specified language.

Body

application/json

The input required to create a challenge group

communityId
string
required

The id of the community the challenge group belongs to

Pattern: ^[0-9a-fA-F]{24}$
details
Details Create Input · object
required

Input for creating entity details with required title

status
enum<string>

Set the challenge group status, by default will be set to draft if not provided

Available options:
archived,
draft,
expired,
live,
scheduled
type
enum<string>

The challenge selection type

Available options:
random,
sequential
period
enum<string>

The rotation period

Available options:
daily,
weekly,
monthly,
yearly,
open
challengeIds
string[]

The challenge IDs in this group

Pattern: ^[0-9a-fA-F]{24}$
activeAmount
number

Number of active challenges to show

Required range: x >= 1

Response

Successful response

A challenge group

id
string
required

The id of the challenge group

Pattern: ^[0-9a-fA-F]{24}$
organisationId
string
required

The id of the organisation the challenge group belongs to

Pattern: ^[0-9a-fA-F]{24}$
communityId
string
required

The id of the community the challenge group belongs to

Pattern: ^[0-9a-fA-F]{24}$
details
Details · object
required

Used to describe an entity

type
enum<string>
required

The challenge selection type

Available options:
random,
sequential
period
enum<string>
required

The rotation period

Available options:
daily,
weekly,
monthly,
yearly,
open
challengeIds
string[]
required

The challenge IDs in this group

Pattern: ^[0-9a-fA-F]{24}$
activeAmount
number
required

Number of active challenges to show

Required range: x >= 1
status
enum<string>
required

The challenge group status

Available options:
archived,
draft,
expired,
live,
scheduled
createdAt
string
required

The creation date of the challenge group

updatedAt
string | null

The update date of the challenge group