🗃️Endpoints - Les lives

Lister les lives du Spot

get

List Lives

Query parameters

pageinteger | nullableoptional

The page number in a paginated set of results

limitinteger | nullableoptional

The limit of results to be returned per page

title[eq]stringoptional

Search Lives with a specific title

title[contains]stringoptional

Search Lives that contains this in the title

status[eq]string · enumoptional

Search Lives with a specific status

Available options:

startDate[lt]integeroptional

Return elements with date before than this

startDate[lte]integeroptional

Return elements with date before than or equal to this

startDate[gt]integeroptional

Return elements with date after than this

startDate[gte]integeroptional

Return elements with date after than or equal to this

startDate[eq]integeroptional

Return elements with date equal to this

solution[in]string · enum[]optional

Search Lives with theses types of solution

solution[eq]string · enumoptional

Search Lives with a specific solution

Available options:

replay[eq]stringoptional

Search Lives with or without replay

builtInType[in]string · enum[]optional

Search Lives with theses types of BuiltInType

builtInType[eq]string · enumoptional

Search Lives with a specific BuiltInType

Available options:

averageViewTime[lt]integeroptional

Return elements with value lower than this

averageViewTime[lte]integeroptional

Return elements with value lower than or equal to this

averageViewTime[gt]integeroptional

Return elements with value greater than this

averageViewTime[gte]integeroptional

Return elements with value greater than or equal to this

averageViewTime[eq]integeroptional

Return elements with value equal to this

invited[lt]integeroptional

Return elements with value lower than this

invited[lte]integeroptional

Return elements with value lower than or equal to this

invited[gt]integeroptional

Return elements with value greater than this

invited[gte]integeroptional

Return elements with value greater than or equal to this

invited[eq]integeroptional

Return elements with value equal to this

registrant[lt]integeroptional

Return elements with value lower than this

registrant[lte]integeroptional

Return elements with value lower than or equal to this

registrant[gt]integeroptional

Return elements with value greater than this

registrant[gte]integeroptional

Return elements with value greater than or equal to this

registrant[eq]integeroptional

Return elements with value equal to this

attendee[lt]integeroptional

Return elements with value lower than this

attendee[lte]integeroptional

Return elements with value lower than or equal to this

attendee[gt]integeroptional

Return elements with value greater than this

attendee[gte]integeroptional

Return elements with value greater than or equal to this

attendee[eq]integeroptional

Return elements with value equal to this

attendanceRate[lt]integeroptional

Return elements with value lower than this

attendanceRate[lte]integeroptional

Return elements with value lower than or equal to this

attendanceRate[gt]integeroptional

Return elements with value greater than this

attendanceRate[gte]integeroptional

Return elements with value greater than or equal to this

attendanceRate[eq]integeroptional

Return elements with value equal to this

totalReplayView[lt]integeroptional

Return elements with value lower than this

totalReplayView[lte]integeroptional

Return elements with value lower than or equal to this

totalReplayView[gt]integeroptional

Return elements with value greater than this

totalReplayView[gte]integeroptional

Return elements with value greater than or equal to this

totalReplayView[eq]integeroptional

Return elements with value equal to this

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://openapi.meltingspot.io/v1/lives'

200

400

200

{
  "items": [
    {
      "id": "text",
      "title": "text",
      "startDate": "2025-04-01T22:03:21.698Z",
      "endDate": "2025-04-01T22:03:21.698Z",
      "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-04-01T22:03:21.698Z",
      "spotId": "text",
      "builtInConfig": {
        "isRecorded": true,
        "recordAvailable": true,
        "videos": {
          "url": "text",
          "quality": "text",
          "encoding": "hls",
          "createdAt": "2025-04-01T22:03:21.698Z"
        },
        "replayVideo": {}
      }
    }
  ],
  "total": 1
}

Lives returned successfully

Créer un Live

post

Create a Live

Body

titlestringrequired

The title of the Live

descriptionstringoptional

Description of the Live (in Markdown)

spotMemberHostIdstringrequired

The Spot member host of the Live

startDateintegerrequired

Start date of the Live (Unix timestamp format)

endDateintegerrequired

End date of the Live (Unix timestamp format)

solutionstring · enumrequired

Solution of the Live

Available options:

builtInTypestring · enum | nullableoptional

BuiltIn type of the Live (if solution is BuiltIn)

Available options:

videoUrlobject | nullableoptional

Video URL of the Live (if solution is Youtube or Vimeo)

chatVisibilitystring · enumoptional

The chat visibility on the Live

Available options:

participantsVisibilitystring · enumoptional

The participant list visibility on the Live

Available options:

visibilitystring · enumoptional

The Live visibility

Available options:

participationstring · enumoptional

Who kind of members can participate to the Live

Available options:

recordbooleanoptional

Active the record on the Live

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/lives' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
  }'

201

400

201

{
  "id": "text",
  "title": "text",
  "startDate": "2025-04-01T22:03:21.698Z",
  "endDate": "2025-04-01T22:03:21.698Z",
  "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-04-01T22:03:21.698Z",
  "spotId": "text",
  "builtInConfig": {
    "isRecorded": true,
    "recordAvailable": true,
    "videos": {
      "url": "text",
      "quality": "text",
      "encoding": "hls",
      "createdAt": "2025-04-01T22:03:21.698Z"
    },
    "replayVideo": {}
  }
}

Live has been successfully created

Récupérer un live du Spot

get

Get a Live

Path parameters

liveIdstringrequired

The id of the Live

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}'

200

400

404

200

{
  "id": "text",
  "title": "text",
  "startDate": "2025-04-01T22:03:21.698Z",
  "endDate": "2025-04-01T22:03:21.698Z",
  "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-04-01T22:03:21.698Z",
  "spotId": "text",
  "builtInConfig": {
    "isRecorded": true,
    "recordAvailable": true,
    "videos": {
      "url": "text",
      "quality": "text",
      "encoding": "hls",
      "createdAt": "2025-04-01T22:03:21.698Z"
    },
    "replayVideo": {}
  }
}

Live found and returned successfully

Modifier un live du Spot

put

Update a Live

Path parameters

liveIdstringrequired

The id of the Live

Body

titlestringrequired

The title of the Live

descriptionstringoptional

Description of the Live (in Markdown)

startDateintegerrequired

Start date of the Live (Unix timestamp format)

endDateintegerrequired

End date of the Live (Unix timestamp format)

chatVisibilitystring · enumoptional

The chat visibility on the Live

Available options:

participantsVisibilitystring · enumoptional

The participant list visibility on the Live

Available options:

visibilitystring · enumoptional

The Live visibility

Available options:

participationstring · enumoptional

Who kind of members can participate to the Live

Available options:

solutionstring · enumrequired

Solution of the Live

Available options:

builtInTypestring · enumoptional

BuiltIn type of the Live (if solution is BuiltIn)

Available options:

recordbooleanoptional

Active the record on the Live

recordAvailablebooleanoptional

Make available the record of the Live

videoUrlstringoptional

Video URL of the Live (if solution is Youtube or Vimeo)

replayVideoUrlobject | nullableoptional

Video URL of the Live (if solution is Youtube or Vimeo)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "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": {}
  }'

200

400

404

200

{
  "id": "text",
  "title": "text",
  "startDate": "2025-04-01T22:03:21.698Z",
  "endDate": "2025-04-01T22:03:21.698Z",
  "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-04-01T22:03:21.698Z",
  "spotId": "text",
  "builtInConfig": {
    "isRecorded": true,
    "recordAvailable": true,
    "videos": {
      "url": "text",
      "quality": "text",
      "encoding": "hls",
      "createdAt": "2025-04-01T22:03:21.698Z"
    },
    "replayVideo": {}
  }
}

Live successfully updated

Supprimer un live du Spot

delete

Delete a Live

Path parameters

liveIdstringrequired

The id of the Live

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}'

204

400

404

204

No body

Live successfully deleted

Désassocier un groupe d'un live

delete

Unlink a group from a live

Path parameters

liveIdstringrequired

The id of the Live

groupIdstringrequired

The id of the group

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/groups/{groupId}'

204

400

404

204

No body

Group successfully unlink

Désassocier plusieurs groupes d'un live

post

Unlink groups from a live

Path parameters

liveIdstringrequired

The id of the Live

Body

groupIdsstring[]required

The ids of the groups to link

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/groups~bulkRemove' \
  --header 'Content-Type: application/json' \
  --data '{
    "groupIds": [
      "text"
    ]
  }'

204

400

404

204

No body

Groups successfully unlink

Lister les groupes d'un live

get

Link a group

Path parameters

liveIdstringrequired

The id of the Live

Query parameters

pageinteger | nullableoptional

The page number in a paginated set of results

limitinteger | nullableoptional

The limit of results to be returned per page

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/groups'

200

400

404

200

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "emoji": "text",
      "icon": "text"
    }
  ],
  "total": 1
}

Group returned successfully

Associer un groupe à un live

post

Link a group

Path parameters

channelIdstringrequired

The id of the channel

Body

groupIdstringrequired

The id of the group to link

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/channels/{channelId}/groups' \
  --header 'Content-Type: application/json' \
  --data '{
    "groupId": "text"
  }'

204

400

404

204

No body

Group linked successfully

Associer plusieurs groupes à un live

post

Link groups

Path parameters

liveIdstringrequired

The id of the Live

Body

groupIdsstring[]required

The ids of the groups to link

withEmailNotificationbooleanoptional

To send an email notification to each added member. Disable by default.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/groups~bulkAdd' \
  --header 'Content-Type: application/json' \
  --data '{
    "groupIds": [
      "text"
    ],
    "withEmailNotification": true
  }'

204

400

404

204

No body

Groups linked successfully

Lister les speakers d'un live

get

List Live speakers

Path parameters

liveIdstringrequired

The id of the Live

Query parameters

pageinteger | nullableoptional

The page number in a paginated set of results

limitinteger | nullableoptional

The limit of results to be returned per page

firstname[eq]stringoptional

Search participants with a specific firstname

firstname[contains]stringoptional

Search participants that contains this in the firstname

lastname[eq]stringoptional

Search participants with a specific lastname

lastname[contains]stringoptional

Search participants that contains this in the lastname

email[eq]stringoptional

Search participants with a specific email

email[contains]stringoptional

Search participants that contains this in the email

status[eq]string · enumoptional

Search participants with a specific status

Available options:

status[in]string · enum[]optional

Search participants with one of theses status

hasReplayed[eq]stringoptional

Search for participants who replayed the Live

hasParticipated[eq]stringoptional

Search for participants who participated to the Live

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/speakers'

200

400

200

{
  "items": [
    {
      "id": "text",
      "liveId": "text",
      "spotMemberId": "text",
      "spotMemberEmail": "text",
      "spotMemberFirstname": {},
      "spotMemberLastname": {},
      "status": "Accepted",
      "type": "Participant",
      "invitedAt": "2025-04-01T22:03:21.698Z",
      "registeredAt": "2025-04-01T22:03:21.698Z",
      "isHighlighted": true,
      "metrics": {
        "viewTime": 1,
        "hasReplayed": true,
        "hasParticipated": true
      }
    }
  ],
  "total": 1
}

Live speakers returned successfully

Lister les participants d'un live

get

List Live participants

Path parameters

liveIdstringrequired

The id of the Live

Query parameters

pageinteger | nullableoptional

The page number in a paginated set of results

limitinteger | nullableoptional

The limit of results to be returned per page

firstname[eq]stringoptional

Search participants with a specific firstname

firstname[contains]stringoptional

Search participants that contains this in the firstname

lastname[eq]stringoptional

Search participants with a specific lastname

lastname[contains]stringoptional

Search participants that contains this in the lastname

email[eq]stringoptional

Search participants with a specific email

email[contains]stringoptional

Search participants that contains this in the email

type[eq]string · enumoptional

Search participants with a specific type

Available options:

type[in]string · enum[]optional

Search participants with one of theses types

status[eq]string · enumoptional

Search participants with a specific status

Available options:

status[in]string · enum[]optional

Search participants with one of theses status

hasReplayed[eq]stringoptional

Search for participants who replayed the Live

hasParticipated[eq]stringoptional

Search for participants who participated to the Live

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/participants'

200

400

200

{
  "items": [
    {
      "id": "text",
      "liveId": "text",
      "spotMemberId": "text",
      "spotMemberEmail": "text",
      "spotMemberFirstname": {},
      "spotMemberLastname": {},
      "status": "Accepted",
      "type": "Participant",
      "invitedAt": "2025-04-01T22:03:21.698Z",
      "registeredAt": "2025-04-01T22:03:21.698Z",
      "isHighlighted": true,
      "metrics": {
        "viewTime": 1,
        "hasReplayed": true,
        "hasParticipated": true
      }
    }
  ],
  "total": 1
}

Live participants returned successfully

Inviter un membre au live

post

Invite a member as Live participant

Path parameters

liveIdstringrequired

The id of the Live

Body

memberstringrequired

Member to invite as Live participant from email address or existing Spot member ID

invitedBySpotMemberIdstringoptional

The Spot member ID on the initiative of the invitation

withEmailNotificationbooleanoptional

Set to true to send notification mail to each invited members

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

201

400

200

No body

Member already invited

Inviter plusieurs membres à un live

post

Invite multiple members as Live participant

Path parameters

liveIdstringrequired

The id of the Live

Body

invitedBySpotMemberIdstringoptional

The Spot member ID on the initiative of the invitation

withEmailNotificationbooleanoptional

Set to true to send notification mail to each invited members

membersall ofrequired

Members to invite

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/participants~bulkInvite' \
  --header 'Content-Type: application/json' \
  --data '{
    "invitedBySpotMemberId": "text",
    "withEmailNotification": true,
    "members": {
      "spotMemberIds": [
        "text"
      ],
      "emails": [
        "text"
      ]
    }
  }'

200

400

413

200

[
  {
    "id": "text",
    "liveId": "text",
    "spotMemberId": "text",
    "spotMemberEmail": "text",
    "spotMemberFirstname": {},
    "spotMemberLastname": {},
    "status": "Accepted",
    "type": "Participant",
    "invitedAt": "2025-04-01T22:03:21.698Z",
    "registeredAt": "2025-04-01T22:03:21.698Z",
    "isHighlighted": true,
    "metrics": {
      "viewTime": 1,
      "hasReplayed": true,
      "hasParticipated": true
    }
  }
]

Members has been successfully invited

Inviter un speaker à un live

post

Invite a member as Live speaker

Path parameters

liveIdstringrequired

The id of the Live

Body

memberone ofrequired

Member to invite as Live participant from email address or existing Spot member ID

invitedBySpotMemberIdstringoptional

The Spot member ID on the initiative of the invitation

highlightedboolean · default: falseoptional

Set to true to highlight the Speaker.

grantHostRightsboolean · default: falseoptional

Set to true to grant Host rights to the Speaker.

withEmailNotificationboolean · default: falseoptional

Set to true to send notification mail to each invited members

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/speakers' \
  --header 'Content-Type: application/json' \
  --data '{
    "member": {
      "email": "text",
      "firstName": "text",
      "lastName": "text",
      "title": "text",
      "biography": "text"
    },
    "invitedBySpotMemberId": "text",
    "highlighted": true,
    "grantHostRights": true,
    "withEmailNotification": true
  }'

200

201

400

200

No body

Member already invited & ignored because invalid status

Inviter plusieurs speakers à un live

post

Invite multiple members as Live speaker

Path parameters

liveIdstringrequired

The id of the Live

Body

invitedBySpotMemberIdstringoptional

The Spot member ID on the initiative of the invitation

highlightedboolean · default: falseoptional

Set to true to highlight the Speaker.

grantHostRightsboolean · default: falseoptional

Set to true to grant Host rights to the Speaker.

withEmailNotificationboolean · default: falseoptional

Set to true to send notification mail to each invited members

spotMemberIdsstring[]required

Spot members to invite as Live speaker

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/lives/{liveId}/speakers~bulkInvite' \
  --header 'Content-Type: application/json' \
  --data '{
    "invitedBySpotMemberId": "text",
    "highlighted": true,
    "grantHostRights": true,
    "withEmailNotification": true,
    "spotMemberIds": [
      "text"
    ]
  }'

200

400

413

200

[
  {
    "id": "text",
    "liveId": "text",
    "spotMemberId": "text",
    "spotMemberEmail": "text",
    "spotMemberFirstname": {},
    "spotMemberLastname": {},
    "status": "Accepted",
    "type": "Participant",
    "invitedAt": "2025-04-01T22:03:21.698Z",
    "registeredAt": "2025-04-01T22:03:21.698Z",
    "isHighlighted": true,
    "metrics": {
      "viewTime": 1,
      "hasReplayed": true,
      "hasParticipated": true
    }
  }
]

Members has been successfully invited