Sign in

v1

latestOpenAPI 3.0.02026-07-24212113249.1 KB
Live Events

Create a live event

post/live-events

Headers

channelstring required

Channel ID

organizationstring required

The URL of the end-user web application

Request body

titlestring required

Live event title

descriptionstring required

Live event description

thumbnailstring required

Path to the image file in cloud storage

orientation'PORTRAIT' | 'LANDSCAPE'

Will the video stream have portrait or landscape orientation?

kind'PUBLIC' | 'EXCLUSIVE' | 'PAYWALL' | 'PRIVATE' | 'GEOLOCKED' | 'AUTO'

Access level determines who can access this live event.

access'AVAILABLE' | 'REDACTED' | 'GEOLOCKED' | 'PUBLIC'

Determines if the access to the event is restricted based on the viewer's geographical location.

scheduledStartAtstring date-time required

The date and time when the event is scheduled to take place.

entitlementsstring[]

Entitlemetns. A string array of product IDs.