Skip to content

Course Import Schema

Donna Peplinskie edited this page Nov 21, 2022 · 13 revisions

The following is the schema used for importing courses in Sensei LMS 3.3+.

Please visit the importer documentation to learn more.

CSV Column Name Example Notes
Id 100 Optional. Unique identifier used to identify course prerequisites.
Course My Course Name Required.
Slug my-course-name Optional. Overwrites content with this slug if it already exists. Note that a course that has never been published will not be overwritten; a new course with the same name will be created instead.
Description This is the course description. Optional. HTML and block markup are supported.
Excerpt This is the course excerpt. Optional.
Teacher Username teacher_username Optional. Teacher with this username and email is created if user doesn’t already exist. If not specified, the currently logged in user is set as the course teacher.
Teacher Email [email protected] Optional. Teacher with this username and email is created if user doesn’t already exist.
Lessons 200 OR slug:lesson-slug OR id:200 Optional. Comma-separated list of lessons. To use a lesson that already exists on the site, use its post ID OR its slug by using the prefix slug:. Note that the lesson must have been published at some point in order to use the slug: prefix. To use a new lesson that will be uploaded simultaneously in a separate CSV file, use the format id:200, where 200 is the value of the Id column for the applicable lesson in the lessons CSV file. New lessons are added to the course in the same order as listed in this column.
Modules Module 1, Module 2 Optional. Comma-separated list of modules. Modules with these names are created if they don’t already exist.
Prerequisite 100 OR slug:course-slug OR id:100 Optional. To add a prerequisite for a course that already exists on the site, use its post ID OR its slug by using the prefix slug:. To add a prerequisite for a new course that is being added in this CSV file, use the format id:100, where 100 is the value of the Id column for the applicable course.
Featured 1 Optional. 0 (default) or 1.
Categories Category 1, Category 1 > Category 2 Optional. Comma-separated list of course categories. > indicates hierarchy. Categories are created if they don’t already exist.
Image http://example.com/image.jpg OR image.jpg Optional. Images need to be pre-uploaded or available online in order to import them. Alternatively, the filename can be used if the image already exists in the media library.
Video <iframe width="560" height="315" src="https://www.youtube.com/embed/abc123" frameborder="0" allowfullscreen></iframe> Optional. Course video embed code.
Disable Notifications 1 Optional. 0 (default) or 1.
Clone this wiki locally