delete_published_course
Destructive
End a published course's visibility on its domain while keeping enrollments, progress, and the course intact. Use the published-course ID to set it inactive, free the slug, and allow republishing.
Instructions
Remove a course from its domain. THIS IS A SOFT UNPUBLISH, NOT A DELETION.
`id` is the published-course id - the publication, not the course.
Despite the name, nothing is destroyed. It sets `live` to false and frees the
slug, exactly as `unpublish_published_course` does - the name matches v1's
DELETE verb rather than the effect. Enrollments, progress and the row itself
survive, and `republish_published_course` reverses it.
`unpublish_published_course` is the same operation under a name that says what
it does; prefer that one unless a caller specifically expects this.
The course itself is untouched - this only ends its publication on one domain.
Requires the `published-courses:write` OAuth scope.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| live | No | ||
| slug | No | ||
| course_id | No | ||
| domain_id | No | ||
| is_hidden | No | ||
| created_at | No | ||
| external_id | No | ||
| modified_at | No | ||
| open_access | No | ||
| visible_on_catalog | No | ||
| access_period_ends_at | No | ||
| access_period_starts_at | No | ||
| visibility_override_type | No | ||
| require_all_prerequisites | No | ||
| allow_self_service_reenroll | No | ||
| unique_progress_per_enrollment | No | ||
| restrict_access_start_end_dates | No | ||
| strict_enforce_group_visibility | No |