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
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:
: 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
}If a participant has already been added to a course, the API won’t fail, but it will update the participant data if the identifier is the same.