Docs home

Create a Course

Creates a new course (Edmingle calls it a course bundle): its name, description, the course modules that make up its curriculum, and its settings. Use it to set up courses from your own system. Pricing per organization and publishing are set separately.

POST/bundles
Create a Course
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/bundles' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --form 'JSONString={"bundle_name":"my Sample aCourse","exam_ids":[],"course_ids":[58286,84573],"bundle_overview":"","course_costs":[0,0],"is_online_package":1,"original_cost":0,"usd_course_costs":[0,0],"is_test_series":0,"bundle_template_data":[],"course_type":1,"online_registration_allowed":true,"android_registration_allowed":true,"ios_registration_allowed":true,"is_course_enrollment_allowed":true,"show_pricing":true}'
{
  "code": 200,
  "message": "Bundle Created",
  "bundle": {
    "bundle_id": 496,
    "bundle_name": "TestCourse",
    "bundle_description": null,
    "stream_id": null,
    "duration": null,
    "bundle_overview": null
  }
}

Access: Institute admins, admins and tutors, plus custom roles that can create courses (or ebooks, playlists or test series for those product types). Not available to Edmingle staff accounts.

Request body: form-data with one field, JSONString, containing this JSON. To set a cover image, also attach an image file as uploaded_file (JPEG, PNG, GIF or WebP, up to 2 MB).

BodyJSONString
bundle_namestringrequired
Course name. HTML tags are removed.
URL slug. Only letters, digits and - are kept. Defaults to the name with other characters removed.
Short description.
bundle_overviewstring (HTML)
Long overview shown on the course page.
course_idsarray of integers
Existing course modules (curriculum) to include. You must be a tutor of each one, or the call fails with "Invalid Course ID".
new_coursesarray of strings
Names of new, empty course modules to create and include.
course_costsarray of numbers
Price for each entry in course_ids, in the same order.
usd_course_costsarray of numbers
USD price for each entry in course_ids, in the same order.
1 regular (default), 2 live, 3 test series.
1 online, 0 offline (default).
durationinteger
Course duration. Default 0.
stream_idinteger
Stream (category) ID.
standard_idsarray of integers
Standard (class/grade) tags.
board_idsarray of integers
Board tags.
exam_idsarray of integers
Category tags.
video_urlstring
Intro video link.
1 lets learners leave the course themselves. Default 0.
1 keeps content available after the learner completes the course. Default 0.
1 lets learners mark their batch as completed. Default 0.
1 shows completion reminders to learners. Default 0.
1 marks the course as a prerequisite course. Default 0.
Feedback form to attach.
1 lets the course content be indexed for AI features. This is charged once per course from your AI balance; the call fails if the balance is too low.
Woolf degree to link (Woolf-accredited institutes only).
1 course (default), 2 event, 3 membership, 4 mentorship, 5 ebook, 6 test series, 7 playlist. Ebooks, test series and playlists need that product on your plan and the matching permission. Cannot be changed later.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Bundle Created
bundleobject
Show child attributesHide child attributes
The new course ID
Example: 496
Example: TestCourse

Notes:

  • Fails with "You have reached a limit of N courses in your plan..." when your plan's course limit is used up.
  • If your institute has only one organization, the course is mapped to it automatically with a price of 0 and the default fee template.
  • Default email templates for the course are created.
  • Rate limit: 30 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI