Skip to content

Create a training quiz key

Workforce module

POST/training-quiz-keystrainingQuizKeys.create

The correct option of a quiz question. Only course editors read it. Creates a training quiz key. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability knowledge.sop.publish.
  • OAuth scopes: knowledge.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: TrainingQuizKeyCreate

trainingQuizKeys.create: TrainingQuizKeyCreate
FieldTypeRequiredDescription
training_quiz_question_idstring (uuid)YesIdentifier of the quiz question.
correct_optionintegerYesCorrect option, from 1.Constraints: range 1 to any
{
  "training_quiz_question_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "correct_option": 1
}

Response 201: TrainingQuizKey

trainingQuizKeys.create: TrainingQuizKey
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the training quiz key.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesPerson who last updated the row; null for seed, platform or system writes.
training_quiz_question_idstring (uuid)YesIdentifier of the quiz question.
correct_optionintegerYesCorrect option, from 1.Constraints: range 1 to any
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "training_quiz_question_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "correct_option": 1
}

Code samples

curl -X POST "$XOS_BASE_URL/training-quiz-keys" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"training_quiz_question_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","correct_option":1}'
const { data } = await xos.trainingQuizKeys.create({
    "training_quiz_question_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "correct_option": 1
  });
response = xos.training_quiz_keys.create({"training_quiz_question_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "correct_option": 1})
xos training-quiz-keys create --data '{"training_quiz_question_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","correct_option":1}'