FAfanhero
Live Events

Update a live event

patch/live-events/{id}

Request

  • Base URL
    https://api.fanheroapi.com
  • URL
    https://api.fanheroapi.com/live-events/{id}
  • Auth
    API key in header apiKey

Path parameters

idstring required

The live event ID

Headers

channelstring required

Channel ID

organizationstring required

The URL of the end-user web application

Request body

titlestring

Live event title

descriptionstring

Live event description

thumbnailstring

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

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

entitlementsstring[]

Entitlemetns. A string array of product IDs.

Response

Live event updated.

Changes

No recorded changes to this operation across all 1 revision of this API.