/api/v3/challenges

post

https://api.sisu.co/api/v3/challenges

Create or update a challenge

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

challenge_id

integer

the ID of the challenge being updated; do not send if creating a new challenge

challenge_filter

string

the filter for challenges 3 different options expired, active, active-pending. 'all' is the default

Body Params

name

string

required

The name of the challenge

scope

string

required

The scope for the challenge; e.g. T12345 is a challenge for team 12345

challenge_type

string

required

The type for the challenge; can be 'E' for Everybody Wins, 'R' for Race, or 'P' for Per-Unit

category_id

integer

required

The category id for the challenge.

priority

boolean

Defaults to false

Whether the challenge is marked as a priority. Preserved on update when omitted.

recurring

string

required

Whether or not the challenge is recurring; 'Y' for Yes, 'N' for No.

threshold

integer

Threshold value for the challenge; required if challenge type is Everybody Wins

threshold_type

string

Threshold type; can be 'C' for Counts or 'V' for Volume; required if challenge type is Everybody Wins

points

integer

The points awarded for completing the challenge. Required if the challenge type is E or P

first_place_points

integer

The points awarded for finishing first. Required if the challenge type is R

second_place_points

integer

The points awarded for finishing second. Required if the challenge type is R

third_place_points

integer

The points awarded for finishing third. Required if the challenge type is R

time_period_type

string

required

The time period type for the challenge. Can be 'D' for Day if daily challenges are enabled, 'W' for Week, 'M' for Month, 'Q' for Quarter, 'Y' for Year, or 'C' for Custom

time_selection_day

string

The day for the challenge. Required if the time period type is D.

time_selection_week

string

The week for the challenge. Required if the time period type is W. Send the date of the Sunday that starts the week

time_selection_month

string

The month for the challenge. Required if the time period type is M.

time_selection_quarter

string

The quarter for the challenge. Required if the time period type is Q.

time_selection_year

string

The year for the challenge. Required if the time period type is Y.

custom_start_date

string

The start date for the challenge. Required if the time period type is C.

custom_end_date

string

The end date for the challenge. Required if the time period type is C.

group_ids

array of integers

The ids of the groups involved in the challenge; required if the scope is GVG.

group_ids

team_ids

array of integers

The ids of the teams involved in the challenge; required if the scope is TVT.

team_ids

Response

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success