UpdateLearningRecordRequest
A request or response body; the type column links to the schemas it refers to.
UpdateLearningRecordRequest
| Field | Type | Required | Description |
|---|---|---|---|
| owner_department_id | string (uuid) | null | no | Move the record to another department of the same organization; null hands it to the organization directly. |
| learner_display_name | string | null | no | 1–300 characters |
| learner_email | string | null | no | 1–300 characters |
| title | string | no | 1–300 characters |
| description | string | null | no | at most 5000 characters |
| status | string | no | rejected cannot be set directly — use the reject endpoint. The learner of a rejected record may set it back to pending, which resubmits it and clears the rejection. one of "pending" | "in_progress" | "completed" | "expired" | "revoked" |
| completed_at | string (date-time) | null | no | — |
| expires_at | string (date-time) | null | no | — |
| external_id | string | null | no | 1–300 characters |
| subject_matter_ids | array of string (uuid) | no | When present, replaces the record's whole subject set. at most 100 items |
| hidden_from_learner | boolean | no | Hide the record from the learner it is about: they can then read it only through records:read over the owner. Needs records:write over the owner — a self-service submission cannot be hidden — and a status other than pending or rejected. |
{
"owner_department_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"learner_display_name": "string",
"learner_email": "string",
"title": "string",
"description": "string",
"status": "pending",
"completed_at": "2026-01-01T00:00:00.000Z",
"expires_at": "2026-01-01T00:00:00.000Z",
"external_id": "string",
"subject_matter_ids": [
"1b671a64-40d5-491e-99b0-da01ff1f3341"
],
"hidden_from_learner": true
}