API

Invite a member as Course participant

POST /v1/courses/{courseId}/participants

Invite a member as Course participant

Path parameters

  • courseId string Required

    The id of the course

application/json

Body Required

  • spotMemberId string Required

    An uuid representing the unique identifier of the spot member to add to course

  • invitedBySpotMemberId string

    The Spot member ID on the initiative of the invitation

  • withEmailNotification boolean

    Set to true to send notification mail to each invited members

Responses

  • 200

    Member already invited

  • 201 application/json

    Member has been successfully invited

    Hide response attributes Show response attributes object
    • id string Required

      The id of the course participant.

    • courseId string Required

      The id of the course.

    • spotMemberId string Required

      The ID of the Spot member associated to the participant

    • spotMemberEmail string Required

      The email of the Spot member associated to the participant

    • spotMemberFirstname object | null Required

      The Spot member firstname associated to the participant. Can be null for a participant invited by email.

    • spotMemberLastname object | null Required

      The Spot member lastname associated to the participant. Can be null for a participant invited by email.

    • status string Required

      The status of the course participant.

      Values are Invited, Started, Completed, or Unenrolled.

    • invitedAt string(date-time) | null Required

      The invitation date of the participant.

    • startedAt string(date-time) | null Required

      The start date of the participant.

    • completedAt string(date-time) | null Required

      The completion date of the participant.

    • unenrolledAt string(date-time) | null Required

      The unenrollment date of the participant.

    • lastActivityAt string(date-time) | null Required

      The last activity date of the participant.

    • completionRate integer Required

      The completion rate of the participant.
  • 400

    Malformed payload

POST /v1/courses/{courseId}/participants 
curl \
 --request POST 'https://openapi.meltingspot.io/v1/courses/{courseId}/participants' \
 --header "Content-Type: application/json" \
 --data '{"spotMemberId":"string","invitedBySpotMemberId":"string","withEmailNotification":true}'
Request examples 
{
  "spotMemberId": "string",
  "invitedBySpotMemberId": "string",
  "withEmailNotification": true
}
Response examples (201) 
{
  "id": "string",
  "courseId": "string",
  "spotMemberId": "string",
  "spotMemberEmail": "string",
  "spotMemberFirstname": {},
  "spotMemberLastname": {},
  "status": "Invited",
  "invitedAt": "2025-05-04T09:42:00Z",
  "startedAt": "2025-05-04T09:42:00Z",
  "completedAt": "2025-05-04T09:42:00Z",
  "unenrolledAt": "2025-05-04T09:42:00Z",
  "lastActivityAt": "2025-05-04T09:42:00Z",
  "completionRate": 42
}