latestSwagger 2.0BSD License2026-08-107753105.4 KB
52b0eb5e8b96
challenge
Edit challenge
Edits a challenge
put/challenge/{public_id}/
Request body
urlstring uri
public_idstring uuid
titlestring required
sloganstring
descriptionstring
startstring date-time required
endstring date-time nullable
type'INDIVIDUAL' | 'GROUP' | 'TEAM' required
goal'DAILY' | 'TOTAL' | 'WEEKLY' | 'MONTHLY' required
goal_valueinteger nullable
goal_type'POINTS' | 'DISTANCE' | 'CALORIES' | 'DURATION' | 'STEPS' required
visibility'PUBLIC' | 'PRIVATE' required
num_membersstring
calculation_method'SUM' | 'AVERAGE' required
goal_progressnumber
Progress towards the goal, from perspective of profile whose bearer is used for authentication: can be an individual/team/global score. When goal is duration, this is the duration in seconds. When an admin token is used, returns 0.0.
enrollment_method'AUTOMATIC' | 'MANUAL' required
default_enrollment_time'CHALLENGE_START' | 'ENROLLMENT_TIME'
Response
OK
urlstring uri
public_idstring uuid
titlestring required
sloganstring
descriptionstring
startstring date-time required
endstring date-time nullable
type'INDIVIDUAL' | 'GROUP' | 'TEAM' required
goal'DAILY' | 'TOTAL' | 'WEEKLY' | 'MONTHLY' required
goal_valueinteger nullable
goal_type'POINTS' | 'DISTANCE' | 'CALORIES' | 'DURATION' | 'STEPS' required
visibility'PUBLIC' | 'PRIVATE' required
num_membersstring
calculation_method'SUM' | 'AVERAGE' required
goal_progressnumber
Progress towards the goal, from perspective of profile whose bearer is used for authentication: can be an individual/team/global score. When goal is duration, this is the duration in seconds. When an admin token is used, returns 0.0.
enrollment_method'AUTOMATIC' | 'MANUAL' required
default_enrollment_time'CHALLENGE_START' | 'ENROLLMENT_TIME'