This document is generated by Aladia.

Add Member

Pending

POST

/courses/{courseId}/members

This endpoint add a profile member to the Course specified by the Id, giving him a contextual role in this specific course.

Expected path parameters:

courseId: Course Id from which the list of members will be returned

Expected body data:

Json object with profileId and his role inside the course, which can be Userand Admin

Returns:

An updated array of the members belonging to the specified Course, containing their data and respective contextual roles

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.aladia.io/v2/courses//members' \
--header 'Content-Type: application/json' \
--data-raw '{
    "profileId": "0ad99ad9242f6e9828446d5b",
    "role": "course-observer"
}'

Response Example

201 - Success

{
    "id": "4dbbdc62ec624e7f1381b8ce",
    "profile": {
        "id": "ce01fc32be3f8d6bdfd96ba8",
        "firstName": "Lilian",
        "lastName": "Lehner",
        "name": "debitis dolorem accusantium",
        "followers": -13660375,
        "hasActiveStory": false,
        "online": false,
        "email": "Verlie_Kertzmann56@hotmail.com",
        "picture": "https://loremflickr.com/640/480/technics"
    },
    "courseId": "e22e4af6c5bb1b616a2ddea8",
    "role": "course-observer",
    "purchased": true,
    "createdAt": "2024-10-14T05:03:13.299Z",
    "updatedAt": "2024-10-13T13:13:00.411Z"
}

Request

Path Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Body

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-04-08 15:36:45

Retrieve All Members

Invite Members