Invite a member as Live participant

POST /v1/lives/{liveId}/participants

Path parameters

liveId string Required

The id of the Live

application/json

Body Required

member string Required

Member to invite as Live participant from email address or existing Spot member ID
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 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

POST /v1/lives/{liveId}/participants

curl \
 --request POST 'https://openapi.meltingspot.io/v1/lives/{liveId}/participants' \
 --header "Content-Type: application/json" \
 --data '{"member":"string","invitedBySpotMemberId":"string","withEmailNotification":true}'

Request examples

{
  "member": "string",
  "invitedBySpotMemberId": "string",
  "withEmailNotification": true
}

Response examples (201)

{
  "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
  }
}