API

Invite members as Learning path participants

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://help-api.meltingspot.io/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
"API MCP server": {
  "url": "https://help-api.meltingspot.io/mcp"
}
Close
POST /v1/learningPaths/{learningPathId}/participants~bulkInvite

Invite members as Learning path participants

Path parameters

  • learningPathId string Required

    The id of the learning path

application/json

Body Required

  • spotMemberIds array[string] Required

    An array of uuid representing the unique identifier of the spot members to add to learning path

  • 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

  • 201 application/json

    Members have been successfully invited

    Hide response attributes Show response attributes object
    • id string Required

      The id of the learning path participant.

    • learningPathId string Required

      The id of the learning path.

    • 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 learning path participant.

      Values are Invited, Started, Completed, or Unenrolled.

    • invitedAt integer | null Required

      Timestamp in ms of invitation date of the participant.

    • startedAt integer | null Required

      Timestamp in ms of start date of the participant.

    • completedAt integer | null Required

      Timestamp in ms of completion date of the participant.

    • unenrolledAt integer | null Required

      Timestamp in ms of unenrollment date of the participant.

    • lastActivityAt integer | null Required

      Timestamp in ms of last activity date of the participant.

    • completionRate integer Required

      The completion rate of the participant.
  • 204

    Members already invited

  • 400

    Malformed payload

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Learning path not found

POST /v1/learningPaths/{learningPathId}/participants~bulkInvite 
curl \
 --request POST 'https://openapi.meltingspot.io/v1/learningPaths/{learningPathId}/participants~bulkInvite' \
 --header "Content-Type: application/json" \
 --data '{"spotMemberIds":["string"],"invitedBySpotMemberId":"string","withEmailNotification":true}'
Request examples 
{
  "spotMemberIds": [
    "string"
  ],
  "invitedBySpotMemberId": "string",
  "withEmailNotification": true
}
Response examples (201) 
[
  {
    "id": "string",
    "learningPathId": "string",
    "spotMemberId": "string",
    "spotMemberEmail": "string",
    "spotMemberFirstname": {},
    "spotMemberLastname": {},
    "status": "Invited",
    "invitedAt": 42,
    "startedAt": 42,
    "completedAt": 42,
    "unenrolledAt": 42,
    "lastActivityAt": 42,
    "completionRate": 42
  }
]