Skip to main content
PUT
Update a scheduled broadcast
Updates a scheduled broadcast. :id is the alphanumeric broadcast_id, while the body’s required scheduled_broadcast_id is the numeric scheduler ID (from create, list, or get).
Full replacement, not a partial update. Before updating, retrieve the current broadcast, change the desired fields, and resend every field that should remain set. Omitting a previously set optional field can clear it. Recurrence cannot be added or changed through this endpoint.
Set roll_forward to true to shift the head of an existing recurring series.
If an update reports incomplete broadcast data, retrieve the current broadcast with Get a scheduled broadcast and resend all fields that should remain set.

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