Invite learner to course API

Invite learner to course API

Description: To invite a learner to your course.
Request URL: /api/v4/<orgId>/addCourseAttendee.json (How do I get my orgId?)
OAuth Scope: TrainerCentral.userapi.CREATE
Method: POST
Request Parameters:
{
"courseAttendee": {
"email"         : <Learner's email address>
"firstName" : <Learner's first name>
"lastName"  : <Learner's last name>
"password"  : <Password for your learner's account>
"courseId"    : <ID of the course you want to invite the learner to. (How do I get my courseId?)
"expiryTime": <Time until which the course is available for free access>
                                               
}
}

Parameter Description:
password : This parameter is optional and needs to be entered only if you've created a password for your learner.
expiryTime : This is an optional parameter that accepts Unix timestamp in milliseconds. For reference, please visit https://currentmillis.com (CurrentMillis is an external website that isn't affiliated with TrainerCentral.)

    • Related Articles

    • Invite learner to academy API

      Description: To invite a learner to your academy. Request URL: /api/v4/<orgId>/addCourseAttendee.json (How to get my <orgId>?) Method: POST OAuth Scope: TrainerCentral.userapi.CREATE Request Parameters: { "courseAttendee": { "email": <Learner's ...

    • List of all TrainerCentral APIs

      Getting Started Get Oauth token API Course APIs Create chapter API Edit chapter API Create course API Edit course API Create lesson API Edit lesson API Create assignment API Delete lesson/live workshop/assignment API Delete chapter API Delete course ...

    • Revoke learner's access to a course API

      Description: To revoke a learner's access to a course. Request URL: <domain>/api/v4/<orgId>/updateCourseAttendee/<courseMemberId>.json Method: PUT OAuth Scope: TrainerCentral.courseapi.UPDATE Parameters: NA Request Body:  {   ...

    • Learner reports API

      Course Report Description: To fetch the course engagement report of a particular learner. Request URL: /api/v4/<orgId>/course/<courseId>/courseMember/<courseMemberId>/courseEngagement.json  (How do I get the courseMemberID?) Method: GET OAuth scope: ...

    • Delete learner API

       Description: To delete the learner. Request URL: /api/v4/<orgId>/portalMembers/<portalMemberId>.json (How do I get my <orgId>?) Method: DELETE OAuth scope: TrainerCentral.presenterapi.DELETE