Skip to main content
POST
Create a scheduled broadcast

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
scheduled_end_ms
string
required

End time, ms since Unix epoch (decimal string).

Pattern: ^[0-9]{1,19}$
scheduled_start_ms
string
required

Start time, ms since Unix epoch (decimal string).

Pattern: ^[0-9]{1,19}$
source_id
string
required

Ingest / source id to bind (same as sources rtmp_stream_key).

Minimum string length: 1
available_for_replay
boolean

Enable replay.

chat_option
string

Chat permission option (numeric string).

Pattern: ^[0-9]{1,19}$
description
string

Description.

is_locked
boolean

Lock the broadcast.

locale
string

Locale.

manual_publish
boolean

If true, do not auto-publish at start; call POST .../live when ready.

recurrence
object

If set, creates a recurring series.

telecast_id
string

Optional telecast id (numeric string).

Pattern: ^[0-9]{1,19}$
thumbnail_media_id
string

Pre-live slate media id (numeric string).

Pattern: ^[0-9]{1,19}$
title
string

Title / status text.

Response

The request has succeeded.

data
object
errors
object[]