RetargetQrCodeRequest

A request or response body; the type column links to the schemas it refers to.

RetargetQrCodeRequest

Field	Type	Required	Description
target_kind	string	yes	What the code points at: one of this deployment's job aids, hosted SCORM courses or quizzes — reached on the learner's own page for it — or a raw http(s) URL anywhere. one of "job_aid" \| "scorm_course" \| "quiz" \| "url"
target_id	string (uuid)	no	For a job_aid, scorm_course or quiz code: the id of that resource, which must belong to the code's organization. Omit for a url code.
target_url	string (uri)	no	For a url code: where it points. Omit for every other kind. 1–2000 characters

Field

Type

Required

Description

target_kind

string

yes

What the code points at: one of this deployment's job aids, hosted SCORM courses or quizzes — reached on the learner's own page for it — or a raw http(s) URL anywhere.

one of "job_aid" | "scorm_course" | "quiz" | "url"

target_id

string (uuid)

For a job_aid, scorm_course or quiz code: the id of that resource, which must belong to the code's organization. Omit for a url code.

target_url

string (uri)

For a url code: where it points. Omit for every other kind.

1–2000 characters

jsonExample

{
  "target_kind": "job_aid",
  "target_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "target_url": "https://example.com/safety-notice"
}