Update Live Event

patch

https://api.3playmedia.com/v3/live/events/{id}

Update a scheduled live event. Only events with scheduled status can be updated. PUT is also accepted.

Immutability rules:

caption_type cannot be changed after creation
audio_source.type cannot change after creation. Fields for the same type (for example url, phone_number, access_information, reconnection_wait_time_minutes) can be updated.
destinations cannot switch between embed-only and encoder-based sets

Replacement semantics: Provided nested objects (audio_source, destinations, wordlists) replace existing values entirely. They are not merged.

Machine translation: Omit machine_translation_languages to leave translation unchanged. Send a new list to add or remove languages, which reprices the order. Send [] to cancel translation. Cancelling the event also cancels translation.

Edit windows:

Professional captioning: General fields locked 30 minutes before start. Timing fields (start_time, estimated_duration_minutes, pre_event_duration_minutes) locked 24 hours before.
Automatic captioning: All changes locked 5 minutes before start.
All other fields, including machine_translation_languages and callback_url, are general fields.

Update errors (422):

Field	Message
`base`	`Only scheduled events can be updated`
`base`	`Event is past the edit window for general field changes`
`base`	`Event is past the edit window for timing changes`
`caption_type`	`caption_type cannot be changed after creation`
`audio_source.type`	`Cannot switch between rtmp_stream and non-stream audio source types`
`destinations`	`Cannot switch between embed-only and encoder-based destination sets`
`estimated_duration_minutes`	`Duration cannot be changed due to length of event. Please cancel and reschedule the event.`

Machine translation errors are the same as on create.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

ID of the live event to update

Body Params

All fields are optional. Only provided fields are changed. Nested objects (audio_source, destinations, wordlists) replace the existing values entirely when provided.

name

string

Display name for the event

start_time

string

Event start time in ISO 8601 format

estimated_duration_minutes

integer

Expected event length in minutes. Must be greater than 0.

pre_event_duration_minutes

integer

Minutes the system or captioner should be ready before the event starts

genre

string

enum

Genre of the event

audio_source

Audio source configuration. Automatic captioning requires rtmp_stream.

destinations

array of objects

length ≥ 1

Where captions are delivered. Replaces the full set when provided.

destinations

3Play caption embed player destination

type

string

enum

required

Allowed:

delay_seconds

integer

2 to 60

Delay in seconds before captions appear (2–60)

static_embed_key_code

string

Key of an existing project static embed key to reuse, so the embed code stays the same across events. Create only; ignored on update. Ignored if no matching key exists in the project.

description

string

Free-text event description

speaker_names

array of strings

Names of event speakers

speaker_names

wordlists

array of strings

Custom vocabulary words. Replaces the full set when provided.

wordlists

contact

object

Event contact information. When provided in a request, name is required and at least one of email or phone must be included.

source_language

string

Source language code (default en). Supported codes depend on the event:

Automatic captioning: en, plus any additional source languages enabled for the account
Professional captioning with an rtmp_stream audio source: not accepted; any value returns is not supported for this order type
Professional captioning with a phone, url, or icap audio source: the languages supported for that event type

An unsupported code returns a 422 that lists the supported codes.

target_language

string

Target language code (default en). Validated against the same codes as source_language.

machine_translation_languages

array of strings

Target languages for real-time machine translation, as language codes. Duplicates and blank values are ignored.

Code	Language
`es-ES`	Spanish (Spain)
`es-419`	Spanish (Latin America)
`pt-BR`	Portuguese (Brazil)
`pt-PT`	Portuguese (Portugal)
`fr-FR`	French (France)
`fr-CA`	French (Canada)
`zh-CN`	Chinese (Simplified)
`ko`	Korean
`vi`	Vietnamese
`ru`	Russian
`tl`	Tagalog
`haw`	Hawaiian
`ar`	Arabic

machine_translation_languages

offensive_words_sensitivity

string

enum

Sensitivity level for filtering offensive words

Allowed:

callback_url

string

HTTP or HTTPS URL that receives a POST when the event finishes. The body is the event object, including downloads and usage, without the code/data response envelope. On update, a blank value removes the callback.

200Success

400Invalid parameter type or format

401Unauthorized

403The project does not have access to live captioning

404No event with this ID in the project

422Validation error