Invite Members
Pending
POST
/courses/{courseId}/members/invite
courseId: Course Id to which the member blongs.membersWithId and membersWIthEmail which are the invitees inside the platform and outside the platform.for those outside the platform
email is required but if the user is inside the platform profileId and the role it's being assigned as an array of objects. The role can be course-teacher and course-attendant.Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.aladia.io/v2/courses//members/invite' \
--header 'apikey: ' \
--header 'Content-Type: application/json' \
--data-raw '{
"membersWithId": [
{
"profileId": "deserunt in",
"role": "laboris",
"cycle": "9bcedd63954dcd9eccbadf66",
"invitedToAllCycles": false
}
],
"membersWithEmail": [
{
"email": "bereketzemed@gmail.com",
"role": "course-attendant",
"invitedToAllCycles": true
}
]
}'Response Response Example
201 - Success
{
"member": [
{
"id": "sint culpa ex quis",
"fullName": "Michelle Wolf",
"picture": "https://loremflickr.com/640/480/nightlife",
"role": null,
"online": false,
"lastActivity": "est cupidatat",
"story": {
"status": "ullamco commodo voluptate",
"nextStoryId": "eiusmod laboris"
},
"email": "Dorthy50@yahoo.com",
"invited": null,
"invitedAt": "2025-01-22T20:04:50.116Z",
"expiresAt": "2025-01-23T01:37:18.982Z"
},
{
"id": "adipisicing",
"fullName": "Daniel Deckow II",
"picture": "https://loremflickr.com/640/480/city",
"role": "aute",
"online": null,
"lastActivity": null,
"story": null,
"email": "Jakob95@hotmail.com",
"invited": true,
"invitedAt": "2025-01-23T07:50:24.080Z",
"expiresAt": "2025-01-23T04:57:00.125Z"
},
{
"id": null,
"fullName": "Aubrey Heller",
"picture": "https://loremflickr.com/640/480/transport",
"role": "tempor in dolor",
"online": false,
"lastActivity": null,
"story": {
"status": "ipsum",
"nextStoryId": "irure adipisicing"
},
"email": "Cleve2@yahoo.com",
"invited": null,
"invitedAt": "2025-01-23T02:19:55.475Z",
"expiresAt": "2025-01-22T18:38:18.515Z"
}
]
}Request
Path Params
courseId
stringÂ
required
Header Params
apikey
stringÂ
optional
Example:
{{apikey}}
Body Params application/json
Responses
Modified at 2025-04-08 15:37:02