ResourcesCourses

Overview

Manage course metadata, access rules, publication state, and ordered curriculum through the API.

Courses are product listings with one course record and one product variant. The course API owns curriculum and course-specific settings; create or delete the underlying course product through the products API.

Every operation requires a token with the listing ability and an X-STORE header. Course, section, lesson, question, answer, attachment, and video relationships are constrained to that selected store.

Endpoints

Curriculum ordering

Section and lesson reorder endpoints accept complete snapshots. Send every current resource ID exactly once. Lesson reorder entries also select the destination section, enabling atomic moves between sections without duplicate or missing order positions.

Draft and publication behavior

is_published controls whether an individual lesson is available to enrolled customers. Course visibility controls the listing. Setting visibility to PUBLIC requires a ready promotional video and at least one published lesson; otherwise the API returns 422 and preserves the draft.

Optimistic writes

Update payloads may include expected_updated_at. If the resource changed after you read it, the API rejects the stale write with 422. Refresh the course or curriculum resource and retry.

Compatibility boundaries

The existing public course preview endpoint is unchanged. Preview sources continue to use ready promotional videos and video lessons marked is_preview; curriculum administration does not expose signed playback tokens.

Seller-authored course titles, descriptions, lesson content, quiz prompts, and assignment instructions are content rather than application localization strings.

On this page