/v1/lives

post https://openapi.meltingspot.io/v1/lives

Create a Live

Body Params

title

string

required

The title of the Live

description

string

Description of the Live (in Markdown)

spotMemberHostId

string

required

The Spot member host of the Live

startDate

integer

required

Start date of the Live (Unix timestamp format)

endDate

integer

required

End date of the Live (Unix timestamp format)

solution

string

required

Solution of the Live

builtInType

string | null

BuiltIn type of the Live (if solution is BuiltIn)

videoUrl

object | null

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

chatVisibility

string

The chat visibility on the Live

participantsVisibility

string

The participant list visibility on the Live

visibility

string

The Live visibility

participation

string

Who kind of members can participate to the Live

record

boolean

Active the record on the Live

Responses

Response body

object

string

required

The id of the Live.

title

string

required

The title of the Live.

startDate

date-time

required

The startDate of the Live.

endDate

date-time

required

The endDate of the Live.

metrics

object

required

The metrics of the Live.

averageViewTime

integer | null

required

The average view time on the Live.

noShow

integer | null

required

The counter of no show of the Live.

totalReplayView

integer | null

required

The counter of total replay viewed on the Live.

registrant

integer | null

required

The counter of registrant on the Live.

attendee

integer | null

required

The counter of attendee on the Live.

attendanceRate

integer | null

required

The attendance rate on the Live.

invited

integer | null

required

The counter of invited on the Live.

description

array of strings

required

The description of the Live.

description*

status

string

required

The status of the Live.

Ended Planned Live

computedStatus

string

required

The computed status of the Live.

Ended Planned Live

solution

string

required

The solution of the Live.

Youtube Vimeo BuiltIn NoSolution

privacy

object

required

The privacy of the Live.

visibility

string

required

The visibility of the Live

AnyOne OnlySpotMembers InvitedMembersOnly

participation

string

required

What kind of members can participate to the Live

AnySpotMembers InvitedMembersOnly

config

object

required

The configuration of the Live.

chatVisibility

string

required

The chat visibility on the Live

Display Hidden

participantsVisibility

string

required

The participants visibility on the Live.

Ended Planned Live

builtInType

string | null

required

The builtIn type of the Live.

Workshop Conference

videoUrl

object | null

required

The video URL of the Live.

Has additional fields

createdAt

date-time

required

The creation date of the Live.

spotId

string

required

The spot ID of the Live.

builtInConfig

object | null

required

The builtIn configuration of the Live.

isRecorded

boolean

required

Indicates if the Live is recorded

recordAvailable

boolean

required

If Live is recorded, indicates if the record is available

videos

object

required

Videos of the replay in multiple formats

replayVideo

object | null

required

URL to video replay

Has additional fields

400

Malformed payload

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://openapi.meltingspot.io/v1/lives \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "solution": "Youtube"
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Live has been successfully created