API

Invite multiple members as Live participant

POST /v1/lives/{liveId}/participants~bulkInvite

Invite multiple members as Live participant

Path parameters

  • liveId string Required

    The id of the Live

application/json

Body Required

  • 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

  • members object Required

    Members to invite

    Hide members attributes Show members attributes object
    • spotMemberIds array[string]

      To invite members from the Spot member ID

    • emails array[string]

      To invite members from email address

Responses

  • 200 application/json

    Members has been successfully invited

    Hide response attributes Show response attributes object
    • id string Required

      The id of the participant.

    • liveId string Required

      The Live id of the participant.

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

      Values are Accepted, Invited, or Declined.

    • type string Required

      The type of the participant.

      Values are Participant, Speaker, or Host.

    • invitedAt string(date-time) | null Required

      The invitation date of the participant.

    • registeredAt string(date-time) | null Required

      The registration date of the participant.

    • isHighlighted boolean Required

      The highlight value of the participant.

    • metrics object Required

      The metrics of the participant.

      Hide metrics attributes Show metrics attributes object
      • viewTime integer | null Required

        The view time on the participant.

      • hasReplayed boolean | null Required

        Indicates if the participant has seen the Live replay

      • hasParticipated boolean | null Required

        Indicates if the participant has participated to the Live.
  • 400

    Malformed payload

  • 413

    Payload is too large

POST /v1/lives/{liveId}/participants~bulkInvite 
curl \
 --request POST 'https://openapi.meltingspot.io/v1/lives/{liveId}/participants~bulkInvite' \
 --header "Content-Type: application/json" \
 --data '{"invitedBySpotMemberId":"string","withEmailNotification":true,"members":{"spotMemberIds":["string"],"emails":["string"]}}'
Request examples 
{
  "invitedBySpotMemberId": "string",
  "withEmailNotification": true,
  "members": {
    "spotMemberIds": [
      "string"
    ],
    "emails": [
      "string"
    ]
  }
}
Response examples (200) 
[
  {
    "id": "string",
    "liveId": "string",
    "spotMemberId": "string",
    "spotMemberEmail": "string",
    "spotMemberFirstname": {},
    "spotMemberLastname": {},
    "status": "Accepted",
    "type": "Participant",
    "invitedAt": "2025-05-04T09:42:00Z",
    "registeredAt": "2025-05-04T09:42:00Z",
    "isHighlighted": true,
    "metrics": {
      "viewTime": 42,
      "hasReplayed": true,
      "hasParticipated": true
    }
  }
]