Skip to main content
PUT
Update Scheduled Stream

Description

Update a scheduled stream. Only streams in a pending state can be updated. Uses the same request schema as schedule creation.

Authentication

This endpoint requires an API Key.
Include your API key in the x-api-key header:

Request

  • Method: PUT
  • Endpoint: /v1/scheduled_streams/{schedule_id}
  • Path Parameter:
    • schedule_id (string, required): ID of the scheduled stream
  • Body:

Response

  • Status: 200 OK
  • Content-Type: application/json

Example Usage (cURL)

Authorizations

X-API-Key
string
header
required

Path Parameters

schedule_id
string
required

schedule_id

Body

application/json
ingest_url
string
required
dst_language
string[]
required
src_language
string
default:en
required
scheduled_time
string<date-time>
required

Scheduled start time in ISO 8601 format (e.g., 2025-12-07T02:00:00Z)

timezone
string
default:""
required
vocals_track
string
default:0
background_track
integer
default:0
mix
string
default:-9,-6
enable_captions_708
boolean
default:false
enable_captions_608
boolean
default:false
start_wowza
boolean
default:false
use_contextual_translation
boolean
default:false
lipsync
boolean
default:true
channel_uuid
string
is_hls_stream
boolean
default:false
stop_time
string<date-time>

Optional scheduled stop time in ISO 8601 format

Response

Successful Response

The response is of type string.