Skip to main content
POST
Assign scenario to user

Authorizations

Authorization
string
header
required

API key created in Settings > API.

Format: exec_live_ followed by 40 alphanumeric characters.

Path Parameters

scenario_id
string
required

Scenario identifier

Body

application/json
user_email
string<email>
required

Email of the user to assign the scenario to

due_date
string<date-time>
required

When the assignment is due (ISO 8601 format)

assigner_email
string<email>

Email of the user creating the assignment (optional, used in notification emails)

attempt_min
integer

Minimum number of attempts required

Required range: x >= 1
attempt_max
integer

Maximum number of attempts allowed

Required range: x >= 1
rank_min
enum<string>

Minimum rank required to complete

Available options:
gold,
silver,
bronze
custom_message
string

Custom message to include with the assignment

Response

Assignment created successfully

A scenario assignment given to a user as a practice task.

id
string

Unique assignment identifier

user
object
scenario
object

A compact scenario reference for embedding in other responses.

status
enum<string>

Current assignment status

Available options:
not_started,
in_progress,
completed,
past_due,
did_not_pass
due_date
string<date-time> | null

When the assignment is due

best_score
number | null

Highest score achieved on this assignment

best_rank
enum<string> | null

Rank from the best scoring attempt

Available options:
gold,
silver,
bronze,
unranked
attempt_count
integer

Number of completed attempts

attempt_min
integer | null

Minimum attempts required

attempt_max
integer | null

Maximum attempts allowed

rank_min
enum<string> | null

Minimum rank required to pass

Available options:
gold,
silver,
bronze,
unranked
program
object | null

Program this assignment belongs to (null if standalone)

created_at
string<date-time>