v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB

Courses::Sections::PublishAction

List Publish Actions

List course-section publish actions for a course

get/courses/{course_id}/sections/publish_actions

Path parameters

course_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

idinteger

Publish Action ID

public_idstring nullable

Publish Action public ID

course_idinteger

ID of the course whose sections are being published

target_allboolean nullable

When true every section of the course is targeted for publishing. Mutually exclusive with target_ids.

target_idsinteger[] nullable

Explicit list of raw (integer) course-section IDs targeted for publishing. The response echoes the raw stored IDs (the create request accepts public IDs, which are decoded on input). Mutually exclusive with target_all.

auto_enrollboolean nullable

When true, existing course enrollees are automatically granted access to the newly published sections.

send_emailboolean nullable

When true (and auto_enroll is also true), enrolled contacts receive an email notification about the newly published sections.

offer_new_section_via_all_access_productsboolean nullable

When true, products that grant full course access are updated to also offer the newly published sections.

target_countinteger nullable

Total number of sections targeted by this action. null until the async job has resolved the count.

performed_countinteger nullable

Number of sections processed so far. Poll alongside target_count to track async progress.

scheduled_forstring date-time nullable

When set, the action is deferred until this datetime. Must be a future datetime. null means execute immediately.

started_atstring date-time nullable

Datetime the async job began processing sections. null until started.

completed_atstring date-time nullable

Datetime the async job finished. null until complete.

created_by_idinteger nullable

ID of the workspace membership that created this action.

approved_by_idinteger nullable

ID of the membership that approved this action (reserved for future use).

created_atstring date-time nullable

Created at datetime

updated_atstring date-time nullable

Updated at datetime

Example response

[
  {
    "id": 1,
    "public_id": "aB3cD4",
    "course_id": 5,
    "target_all": false,
    "target_ids": [
      8,
      9
    ],
    "auto_enroll": true,
    "send_email": true,
    "offer_new_section_via_all_access_products": false,
    "target_count": 2,
    "performed_count": 1,
    "scheduled_for": null,
    "started_at": "2025-01-01T00:01:00.000Z",
    "completed_at": null,
    "created_by_id": 3,
    "approved_by_id": null,
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:01:00.000Z"
  }
]