Assign scenario to user

Assign a scenario to a user as a task or homework assignment. The user will receive notification of the assignment and can track their progress.

POST /scenarios/{scenario_id}/assignments

Assign scenario to user

cURL

curl --request POST \
  --url https://api.exec.com/rest/v1/scenarios/{scenario_id}/assignments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_email": "[e-mail]",
  "due_date": "2024-03-15T17:00:00Z",
  "assigner_email": "[e-mail]",
  "attempt_min": 1,
  "attempt_max": 5,
  "rank_min": "silver",
  "custom_message": "Please complete this discovery call practice by Friday"
}
'

200

{
  "id": "a1s2s3i4g5n6",
  "scenario_id": "s1c2e3n4a5r6",
  "user_email": "[e-mail]",
  "due_date": "2024-03-15T17:00:00Z",
  "attempt_min": 1,
  "attempt_max": 5,
  "rank_min": "silver",
  "custom_message": "Please complete this discovery call practice by Friday",
  "status": "not_started",
  "created_at": "2024-03-01T10:00:00Z"
}

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

The scenario ID

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: bronze, silver, gold

custom_message · string

Custom message to include with the assignment

Response

200

application/json

Assignment created successfully

id · string

Unique assignment identifier (12-character hex string)

scenario_id · string

The scenario ID

user_email · string<email>

Email of the assigned user

due_date · string<date-time>

When the assignment is due

attempt_min · integer | null

Minimum number of attempts required

attempt_max · integer | null

Maximum number of attempts allowed

rank_min · enum<string> | null

Minimum rank required to complete

Available options: bronze, silver, gold

custom_message · string | null

Custom message included with the assignment

status · enum<string>

Current status of the assignment

Available options: not_started, in_progress, completed, past_due, did_not_pass

created_at · string<date-time>

When the assignment was created