Create Curriculum
Creates a curriculum (a course of sections and materials that batches are taught from). Use it to set up course content before adding sections, materials and batches.
POST
/tutor/coursesCreate Curriculum
curl --request POST \
--url 'https://<your-api-host>/nuSource/api/v1/tutor/courses' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>' \
--form 'JSONString={"name":"Course 1","description":"Course 1 Description","category":3,"privacy_type":"public","engage_subject_tag_id":1,"organization_id":[<organizationId>]}'{
"code": 200,
"message": "Course Created",
"course": {
"course_id": 50286,
"name": "Course 1",
"description": "Course 1 Description",
"category": 3,
"course_type": "custom",
"organization_id": [
212
],
"privacy_type": "public",
"engage_subject_tag_id": 1
}
}Access: Institute admins, plus custom roles that can create curriculum. Tutors get "Tutor not allowed to add/edit resource inside department.".
Request body: form-data with one field, JSONString, containing this JSON. Optionally add a cover image as a file field named uploaded_file (JPEG, PNG or GIF, up to 1 MB).
Body
JSONStringCurriculum name. No
< or >.Course category ID.
ID of the subject tag to link the curriculum to. The examples use
1.descriptionstring
Up to 500 characters. No
< or >.privacy_typestring
public or private. Default private.course_typestring
custom (default) or template. The response always shows custom.organization_idarray of integers
Organizations to make the curriculum available in. Default: your current organization.
costnumber
Price stored with the curriculum in each organization. Default 0.
product_typeinteger
1 Course (default), 2 Event, 3 Membership, 4 Mentorship, 5 eBook, 6 Test series, 7 Playlist. Other values return "Invalid product_type".tag_onlyinteger
0 or 1. Curricula with 1 are hidden from the curriculum list. Purpose otherwise unclear from code.is_time_restrictedinteger
1 turns on time restriction for the curriculum. Default 0.Multiplier used with time restriction. Default 1.
woolf_course_idstring
Woolf course ID. Setting it marks the curriculum as Woolf accredited.
Response
codeinteger
Example:
200messagestring
Example:
Course Createdcourseobject
Show child attributesHide child attributes
course.namestring
Example:
Course 1course.descriptionstring
Example:
Course 1 Descriptioncourse.categoryinteger
Example:
3course.course_typestring
Example:
customcourse.organization_idinteger[]
Array
course.privacy_typestring
Example:
publiccourse.engage_subject_tag_idinteger
Example:
1Notes: The curriculum starts with no sections; add content with the curriculum endpoints. Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.