Courses
Update Course
Update an existing Course record.
PUT
Update Course
Updates an existing Course record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the Course-Edit role.Enums
eCourseVisibility — Visibility values
eCourseVisibility — Visibility values
| Value | Name |
|---|---|
| 1 | Public |
| 2 | Hidden |
| 3 | Private |
| 4 | Paid |
Request Body
Required Fields
The Id of the Course record to update.
ID of the Location this course belongs to.
ID of the coworker or administrator who hosts this course.
Course title displayed on the Members Portal.
Position of the course in listing pages; lower numbers appear first.
Access control for the course: Public (1), Hidden from listing but accessible via link (2), Private/invite-only (3), or Paid via TariffId (4).
Optional Fields
Short summary displayed under the course title on the Members Portal (up to ~400 characters).
Full course description shown in the ‘What’s this course about?’ section when customers open the course.
Whether to display the overview section on the course page.
Whether the course has an associated community discussion group on the Members Portal.
Overview text displayed below the full description on the course page.
URL of a new thumbnail image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).
Set to true to remove the existing thumbnail image.
URL of a new banner/large image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).
Set to true to remove the existing banner/large image.
Whether the course is active and available to customers.
Optional group label used to cluster related courses together on the Members Portal.
Whether the course is featured on the Members Portal home page.
ID of the pricing plan (tariff) required to access this course when Visibility is Paid.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the update.
Contains the
Id of the updated record.true if the course was updated successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response
Update Course