Skip to main content
PUT
Update a scheduled broadcast

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required
Pattern: ^[a-zA-Z0-9]{1,13}$

Body

application/json
scheduled_broadcast_id
string
required

Numeric scheduler id from create/list/get.

Pattern: ^[0-9]{1,19}$
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}$
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.

roll_forward
boolean

When true, shift the head of a recurring series.

source_id
string

Ingest / source id.

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[]