v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Training

Enroll Users to Course

❗️ End of Support Notification

As of December 5, 2025, this API is now deprecated. For more information, see OneTrust API Sunsetting & Deprecation Guidelines.

Use this API to enroll users into a specific course.

🗒 Things to Know

  • Any number of users can be enrolled into the specified course per each API call.
post/v2/enrollments

Request body

courseIdstring uuid required

ID assigned to each course. The value is obtained from Get List of Courses API.

courseNamestring required

Name of the course.

courseNameKeystring required

NameKey assigned to each course.

deadlinestring date-time required

The date and time at which the course should be completed. The format is YYYY-MM-DDTHH:MM:SS.FFFZ

defaultLanguageIdstring uuid required

Valid unique id assigned to each language. The value is obtained from Get List of Courses API.

defaultLanguageKeystring required

Valid unique nameKey assigned to each language.

defaultLanguageNamestring required

Valid unique name assigned to each language.

courseLanguageVersioninteger required

Version of the course for particular language.

commentsstring

Comments added if any while enrolling the users to the course.

Response

Enroll users request has been accepted.

string uuid required