Start a Course

Developing

POST

/courses/{id}/start/

This endpoint adds a free course to the user's learning space.

Optional body parameters

Accepts a cycle id for live courses

Alternative starting process for free courses:
Since there is no checkout process for free courses, this endpoints allows any user to start a free course by making him a course member, action which is automatically done after adding the course to his learning space.

Events that should be listened:
Since the course membership continues to be handled assynchronously, to correctly display the course fruition page, the event COURSE_MEMBER_ADDED should also be awaited in this process as well.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.aladia.io/v2/courses//start/' \
--header 'apikey: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cycle": "9163cf004411d4c8a2fbca6a"
}'

Response Example

201 - Success

{
  "started": true
}

Request

Path Params

string

required

Header Params

apikey

string

optional

Example:

Body Params application/json

cycle

string

optional

purchased cycle for a live course

Examples

Responses

🟢201Created

application/json

Body

object {0}

🟠401Unauthorized

Modified at 2025-04-09 09:40:01

Review a Course

Create a Cycle