This article is also available in:
With our simple API you can automatically add participants to your Courses and send them an invitation.

API Language

Our API accepts application/x-www-form-urlencoded or multipart/form-data and json.

Course API

Add participant

This API call is for Courses that are by invitation only.

HTTP method: POST

Endpoint: https://dashboard-api.easy-lms.com/v1/course/{COURSE_ID}/add-participant

You need to enter the ID of the Course in the endpoint URL in place of {COURSE_ID}. You can find this ID by going to Dashboard > Courses > Course > Integrations > API.

Headers:

Content-Type: application/json
X-Api-Key: API key secret


The API key secret can be generated (or regenerated) by going to My account > Advanced setup > API access. Make sure you save the API key secret somewhere safe. Once you leave (or refresh) the page it will NOT be shown again for security reasons!

Content:

{
  "name": "Participant",
  "email": "participant@email.com"
}


Simply enter the name and email address of the participant you want to add.

Success response:

{
    "status": "ok",
    "participant": {
        "name": "Participant",
        "email": "participant@email.com",
        "uuid": "4f59ba19-fd70-43f8-bcb2-3b2eb5bd1234"
    }
}


Example error response:

{
    "name": "Conflict",
    "message": "Duplicate entry",
    "code": 0,
    "status": 409
}


A participant can only be added once to each Course.
Was this article helpful?
Cancel
Thank you!