Finish a lesson
Workforce module
POST/training-lessons/{id}/completetrainingLessons.complete
Marks a reading or video lesson finished for the caller. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability knowledge.sop.acknowledge.
- OAuth scopes: knowledge.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the training lesson. |
Response 200: TrainingLesson
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the training lesson. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Person who last updated the row; null for seed, platform or system writes. |
| training_course_id | string (uuid) | Yes | Identifier of the course. |
| position | integer | Yes | Order, from 1.Constraints: range 1 to any |
| title | string | Yes | Lesson title.Constraints: length 1 to 200 |
| lesson_kind | "Reading" | "Video" | "Quiz" | Yes | Lesson kind. |
| body | string | null | Yes | Reading text or notes.Constraints: length 1 to 20000 |
| video_url | string (uri) | null | Yes | HTTPS address of the lesson video. |
{
"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_course_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"position": 1,
"title": "Slings",
"lesson_kind": "Reading",
"body": "Inspect every sling before use.",
"video_url": "https://northwindlive.example/files/site-plan.pdf"
}Code samples
curl -X POST "$XOS_BASE_URL/training-lessons/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/complete" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.trainingLessons.complete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.training_lessons.complete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos training-lessons complete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f