Create a live event

post

https://api.fanheroapi.com/live-events

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Overview

Creates a live event.

📘
Note that if the kind parameter is set to PAYWALL, there needs to be a product ID in the entitlements array to identify the product that the user needs to pay for in order to gain access to the live event.

Header parameters organization and channel are required.

Body Params

title

string

required

Live event title

description

string

required

Live event description

thumbnail

string

required

Path to the image file in cloud storage

orientation

string

enum

Will the video stream have portrait or landscape orientation?

Allowed:

kind

string

enum

Access level determines who can access this live event.

Allowed:

access

string

enum

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

Allowed:

scheduledStartAt

date-time

required

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

entitlements

array of strings

Entitlemetns. A string array of product IDs.

entitlements

geoFence

object

Headers

channel

string

required

Channel ID

organization

string

required

The URL of the end-user web application

Response

201

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here!

Overview

Note that if the kind parameter is set to PAYWALL, there needs to be a product ID in the entitlements array to identify the product that the user needs to pay for in order to gain access to the live event.

Note that if the `kind` parameter is set to PAYWALL, there needs to be a product ID in the `entitlements` array to identify the product that the user needs to pay for in order to gain access to the live event.