Docs home

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/courses
Create 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 Details","category":3,"privacy_type":"public","engage_subject_tag_id":1,"organization_id":[2],"is_time_restricted":0}'
{
  "code": 200,
  "message": "Course Created",
  "course": {
    "course_id": 2083,
    "name": "Course 1 ",
    "description": "Course Details",
    "category": 3,
    "course_type": "custom",
    "organization_id": [
      2
    ],
    "privacy_type": "public",
    "engage_subject_tag_id": 1,
    "is_time_restricted": 0,
    "time_rest_multiplier": null
  }
}

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).

BodyJSONString
namestringrequired
Curriculum name. No < or >.
categoryintegerrequired
Course category ID.
engage_subject_tag_idintegerrequired
ID of the subject tag to link the curriculum to. The examples use 1.
Up to 500 characters. No < or >.
public or private. Default private.
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.
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.
1 turns on time restriction for the curriculum. Default 0.
Multiplier used with time restriction. Default 1.
Woolf course ID. Setting it marks the curriculum as Woolf accredited.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Course Created
courseobject
Show child attributesHide child attributes
The new ID
Example: 2083
Example: Course 1
Example: Course Details
Example: 3
Example: custom
Example: public
Example: 0

Notes: 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.

Updated yesterday

Ask AI