🗃️Endpoints - Lives
List lives
List Lives
The page number in a paginated set of results
The limit of results to be returned per page
Search Lives with a specific title
Search Lives that contains this in the title
Search Lives with a specific status
Return elements with date before than this
Return elements with date before than or equal to this
Return elements with date after than this
Return elements with date after than or equal to this
Return elements with date equal to this
Search Lives with a specific solution
Search Lives with or without replay
Search Lives with a specific BuiltInType
Return elements with value lower than this
Return elements with value lower than or equal to this
Return elements with value greater than this
Return elements with value greater than or equal to this
Return elements with value equal to this
Return elements with value lower than this
Return elements with value lower than or equal to this
Return elements with value greater than this
Return elements with value greater than or equal to this
Return elements with value equal to this
Return elements with value lower than this
Return elements with value lower than or equal to this
Return elements with value greater than this
Return elements with value greater than or equal to this
Return elements with value equal to this
Return elements with value lower than this
Return elements with value lower than or equal to this
Return elements with value greater than this
Return elements with value greater than or equal to this
Return elements with value equal to this
Return elements with value lower than this
Return elements with value lower than or equal to this
Return elements with value greater than this
Return elements with value greater than or equal to this
Return elements with value equal to this
Return elements with value lower than this
Return elements with value lower than or equal to this
Return elements with value greater than this
Return elements with value greater than or equal to this
Return elements with value equal to this
Lives returned successfully
Malformed payload
GET /v1/lives HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
"items": [
{
"id": "text",
"title": "text",
"startDate": "2025-08-08T07:18:13.201Z",
"endDate": "2025-08-08T07:18:13.201Z",
"metrics": {
"averageViewTime": 1,
"noShow": 1,
"totalReplayView": 1,
"registrant": 1,
"attendee": 1,
"attendanceRate": 1,
"invited": 1
},
"description": [
{
"type": "p",
"children": [
{
"text": "My new live"
}
]
}
],
"status": "Ended",
"computedStatus": "Ended",
"solution": "Youtube",
"privacy": {
"visibility": "AnyOne",
"participation": "AnySpotMembers"
},
"config": {
"chatVisibility": "Display",
"participantsVisibility": "Ended"
},
"builtInType": "Workshop",
"videoUrl": {},
"createdAt": "2025-08-08T07:18:13.201Z",
"spotId": "text",
"builtInConfig": {
"isRecorded": true,
"recordAvailable": true,
"videos": {
"url": "text",
"quality": "text",
"encoding": "hls",
"createdAt": "2025-08-08T07:18:13.201Z"
},
"replayVideo": {}
}
}
],
"total": 1
}Create a live
Create a Live
The title of the Live
Description of the Live (in Markdown)
The Spot member host of the Live
Start date of the Live (Unix timestamp format)
End date of the Live (Unix timestamp format)
Solution of the Live
BuiltIn type of the Live (if solution is BuiltIn)
Video URL of the Live (if solution is Youtube or Vimeo)
The chat visibility on the Live
The participant list visibility on the Live
The Live visibility
Who kind of members can participate to the Live
Active the record on the Live
Live has been successfully created
Malformed payload
POST /v1/lives HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 280
{
"title": "text",
"description": "text",
"spotMemberHostId": "text",
"startDate": 1,
"endDate": 1,
"solution": "Youtube",
"builtInType": "Workshop",
"videoUrl": {},
"chatVisibility": "Display",
"participantsVisibility": "Display",
"visibility": "AnyOne",
"participation": "AnySpotMembers",
"record": true
}{
"id": "text",
"title": "text",
"startDate": "2025-08-08T07:18:13.201Z",
"endDate": "2025-08-08T07:18:13.201Z",
"metrics": {
"averageViewTime": 1,
"noShow": 1,
"totalReplayView": 1,
"registrant": 1,
"attendee": 1,
"attendanceRate": 1,
"invited": 1
},
"description": [
{
"type": "p",
"children": [
{
"text": "My new live"
}
]
}
],
"status": "Ended",
"computedStatus": "Ended",
"solution": "Youtube",
"privacy": {
"visibility": "AnyOne",
"participation": "AnySpotMembers"
},
"config": {
"chatVisibility": "Display",
"participantsVisibility": "Ended"
},
"builtInType": "Workshop",
"videoUrl": {},
"createdAt": "2025-08-08T07:18:13.201Z",
"spotId": "text",
"builtInConfig": {
"isRecorded": true,
"recordAvailable": true,
"videos": {
"url": "text",
"quality": "text",
"encoding": "hls",
"createdAt": "2025-08-08T07:18:13.201Z"
},
"replayVideo": {}
}
}Delete a live
Delete a Live
The id of the Live
Live successfully deleted
Malformed payload
Live not found
DELETE /v1/lives/{liveId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
Aucun contenu
Update a live
Update a Live
The id of the Live
The title of the Live
Description of the Live (in Markdown)
Start date of the Live (Unix timestamp format)
End date of the Live (Unix timestamp format)
The chat visibility on the Live
The participant list visibility on the Live
The Live visibility
Who kind of members can participate to the Live
Solution of the Live
BuiltIn type of the Live (if solution is BuiltIn)
Active the record on the Live
Make available the record of the Live
Video URL of the Live (if solution is Youtube or Vimeo)
Video URL of the Live (if solution is Youtube or Vimeo)
Live successfully updated
Malformed payload
Live not found
PUT /v1/lives/{liveId} HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 301
{
"title": "text",
"description": "text",
"startDate": 1,
"endDate": 1,
"chatVisibility": "Display",
"participantsVisibility": "Display",
"visibility": "AnyOne",
"participation": "AnySpotMembers",
"solution": "Youtube",
"builtInType": "Workshop",
"record": true,
"recordAvailable": true,
"videoUrl": "text",
"replayVideoUrl": {}
}{
"id": "text",
"title": "text",
"startDate": "2025-08-08T07:18:13.201Z",
"endDate": "2025-08-08T07:18:13.201Z",
"metrics": {
"averageViewTime": 1,
"noShow": 1,
"totalReplayView": 1,
"registrant": 1,
"attendee": 1,
"attendanceRate": 1,
"invited": 1
},
"description": [
{
"type": "p",
"children": [
{
"text": "My new live"
}
]
}
],
"status": "Ended",
"computedStatus": "Ended",
"solution": "Youtube",
"privacy": {
"visibility": "AnyOne",
"participation": "AnySpotMembers"
},
"config": {
"chatVisibility": "Display",
"participantsVisibility": "Ended"
},
"builtInType": "Workshop",
"videoUrl": {},
"createdAt": "2025-08-08T07:18:13.201Z",
"spotId": "text",
"builtInConfig": {
"isRecorded": true,
"recordAvailable": true,
"videos": {
"url": "text",
"quality": "text",
"encoding": "hls",
"createdAt": "2025-08-08T07:18:13.201Z"
},
"replayVideo": {}
}
}Get a live
Get a Live
The id of the Live
Live found and returned successfully
Malformed payload
Live not found
GET /v1/lives/{liveId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
"id": "text",
"title": "text",
"startDate": "2025-08-08T07:18:13.201Z",
"endDate": "2025-08-08T07:18:13.201Z",
"metrics": {
"averageViewTime": 1,
"noShow": 1,
"totalReplayView": 1,
"registrant": 1,
"attendee": 1,
"attendanceRate": 1,
"invited": 1
},
"description": [
{
"type": "p",
"children": [
{
"text": "My new live"
}
]
}
],
"status": "Ended",
"computedStatus": "Ended",
"solution": "Youtube",
"privacy": {
"visibility": "AnyOne",
"participation": "AnySpotMembers"
},
"config": {
"chatVisibility": "Display",
"participantsVisibility": "Ended"
},
"builtInType": "Workshop",
"videoUrl": {},
"createdAt": "2025-08-08T07:18:13.201Z",
"spotId": "text",
"builtInConfig": {
"isRecorded": true,
"recordAvailable": true,
"videos": {
"url": "text",
"quality": "text",
"encoding": "hls",
"createdAt": "2025-08-08T07:18:13.201Z"
},
"replayVideo": {}
}
}Unlike a group from a live
Unlink a group from a live
The id of the Live
The id of the group
Group successfully unlink
Malformed payload
Live or Group not found
DELETE /v1/lives/{liveId}/groups/{groupId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
Aucun contenu
Unlike multiple groups from a live
Unlink groups from a live
The id of the Live
The ids of the groups to link
Groups successfully unlink
Malformed payload
Live not found
POST /v1/lives/{liveId}/groups~bulkRemove HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"groupIds": [
"text"
]
}Aucun contenu
List groups
Link a group
The id of the Live
The page number in a paginated set of results
The limit of results to be returned per page
Group returned successfully
Malformed payload
Live not found
GET /v1/lives/{liveId}/groups HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
"items": [
{
"id": "text",
"name": "text",
"description": "text",
"emoji": "text",
"icon": "text"
}
],
"total": 1
}Link a group
Link a group
The id of the Live
The id of the group to link
To send an email notification to each added member. Disable by default.
Group linked successfully
Malformed payload
Live not found
POST /v1/lives/{liveId}/groups HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"groupId": "text",
"withEmailNotification": true
}Aucun contenu
Link multiple groups
Link groups
The id of the channel
The ids of the groups to link
Groups linked successfully
Malformed payload
Channel not found
POST /v1/channels/{channelId}/groups~bulkAdd HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"groupIds": [
"text"
]
}Aucun contenu
Invite a member as live speaker
Invite a member as Live speaker
The id of the Live
Member to invite as Live participant from email address or existing Spot member ID
The Spot member ID on the initiative of the invitation
Set to true to highlight the Speaker.
falseSet to true to grant Host rights to the Speaker.
falseSet to true to send notification mail to each invited members
falseMember already invited & ignored because invalid status
Member has been successfully invited
Malformed payload
POST /v1/lives/{liveId}/speakers HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 203
{
"member": {
"email": "text",
"firstName": "text",
"lastName": "text",
"title": "text",
"biography": "text"
},
"invitedBySpotMemberId": "text",
"highlighted": false,
"grantHostRights": false,
"withEmailNotification": false
}Aucun contenu
Liste live speaker
List Live speakers
The id of the Live
The page number in a paginated set of results
The limit of results to be returned per page
Search participants with a specific firstname
Search participants that contains this in the firstname
Search participants with a specific lastname
Search participants that contains this in the lastname
Search participants with a specific email
Search participants that contains this in the email
Search participants with a specific status
Search for participants who replayed the Live
Search for participants who participated to the Live
Live speakers returned successfully
Malformed payload
GET /v1/lives/{liveId}/speakers HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
"items": [
{
"id": "text",
"liveId": "text",
"spotMemberId": "text",
"spotMemberEmail": "text",
"spotMemberFirstname": {},
"spotMemberLastname": {},
"status": "Accepted",
"type": "Participant",
"invitedAt": "2025-08-08T07:18:13.201Z",
"registeredAt": "2025-08-08T07:18:13.201Z",
"isHighlighted": true,
"metrics": {
"viewTime": 1,
"hasReplayed": true,
"hasParticipated": true
}
}
],
"total": 1
}Invite a member as live participant
Invite a member as Live participant
The id of the Live
Member to invite as Live participant from email address or existing Spot member ID
The Spot member ID on the initiative of the invitation
Set to true to send notification mail to each invited members
Member already invited
Member has been successfully invited
Malformed payload
POST /v1/lives/{liveId}/participants HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 77
{
"member": "text",
"invitedBySpotMemberId": "text",
"withEmailNotification": true
}Aucun contenu
List live participants
List Live participants
The id of the Live
The page number in a paginated set of results
The limit of results to be returned per page
Search participants with a specific firstname
Search participants that contains this in the firstname
Search participants with a specific lastname
Search participants that contains this in the lastname
Search participants with a specific email
Search participants that contains this in the email
Search participants with a specific type
Search participants with a specific status
Search for participants who replayed the Live
Search for participants who participated to the Live
Live participants returned successfully
Malformed payload
GET /v1/lives/{liveId}/participants HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
"items": [
{
"id": "text",
"liveId": "text",
"spotMemberId": "text",
"spotMemberEmail": "text",
"spotMemberFirstname": {},
"spotMemberLastname": {},
"status": "Accepted",
"type": "Participant",
"invitedAt": "2025-08-08T07:18:13.201Z",
"registeredAt": "2025-08-08T07:18:13.201Z",
"isHighlighted": true,
"metrics": {
"viewTime": 1,
"hasReplayed": true,
"hasParticipated": true
}
}
],
"total": 1
}Invite multiple members as live speaker
Invite multiple members as Live speaker
The id of the Live
The Spot member ID on the initiative of the invitation
Set to true to highlight the Speaker.
falseSet to true to grant Host rights to the Speaker.
falseSet to true to send notification mail to each invited members
falseSpot members to invite as Live speaker
Members has been successfully invited
Malformed payload
Payload is too large
POST /v1/lives/{liveId}/speakers~bulkInvite HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 131
{
"invitedBySpotMemberId": "text",
"highlighted": false,
"grantHostRights": false,
"withEmailNotification": false,
"spotMemberIds": [
"text"
]
}[
{
"id": "text",
"liveId": "text",
"spotMemberId": "text",
"spotMemberEmail": "text",
"spotMemberFirstname": {},
"spotMemberLastname": {},
"status": "Accepted",
"type": "Participant",
"invitedAt": "2025-08-08T07:18:13.201Z",
"registeredAt": "2025-08-08T07:18:13.201Z",
"isHighlighted": true,
"metrics": {
"viewTime": 1,
"hasReplayed": true,
"hasParticipated": true
}
}
]Invite multiple members as live participants
Invite multiple members as Live participant
The id of the Live
The Spot member ID on the initiative of the invitation
Set to true to send notification mail to each invited members
Members to invite
Members has been successfully invited
Malformed payload
Payload is too large
POST /v1/lives/{liveId}/participants~bulkInvite HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 116
{
"invitedBySpotMemberId": "text",
"withEmailNotification": true,
"members": {
"spotMemberIds": [
"text"
],
"emails": [
"text"
]
}
}[
{
"id": "text",
"liveId": "text",
"spotMemberId": "text",
"spotMemberEmail": "text",
"spotMemberFirstname": {},
"spotMemberLastname": {},
"status": "Accepted",
"type": "Participant",
"invitedAt": "2025-08-08T07:18:13.201Z",
"registeredAt": "2025-08-08T07:18:13.201Z",
"isHighlighted": true,
"metrics": {
"viewTime": 1,
"hasReplayed": true,
"hasParticipated": true
}
}
]Mis à jour
Ce contenu vous a-t-il été utile ?