Skip to main content
PATCH
Update a video

Merge-patch by feature

The request body is grouped by player feature — controls, playback, turbo, smart_autoplay, pixels, and more. It is a merge-patch: send only the groups you want to change, and within a group only the keys you touch; everything else keeps its stored value. Each group is collapsed below — expand the ones you need. New here? How merge-patch works covers the rules in a page; every feature also has a focused guide under the Guides tab.

Authorizations

Authorization
string
header
required

Paste your VTurb API token (vt_...). Sent as Authorization: Bearer <token>.

Path Parameters

id
string
required

Body

application/json
controls
object

Player chrome toggles — each key shows or hides one on-screen control. See the Update controls guide for a focused example.

alternative_video
object

Fallback video for viewers who can't play the main one. See the Update alternative video guide.

immersive_mode
object

The fullscreen takeover — where it runs and when it expands. See the Update immersive mode guide.

traffic_filter
object

Routes unwanted traffic — wrong country, wrong device, proxies — to a fallback video. See the Update traffic filter guide.

playback
object

Pause behavior, the scroll-to-action moment, and what happens when the video ends. See the Update playback guide.

progress_bar
object

The decoy progress bar — height, color, and whether it borrows the player's palette. See the Update progress bar guide.

subtitle
object

Caption toggle and styling; the track file itself is read-only. See the Update subtitle guide.

resume
object

The keep-watching prompt returning viewers see — its copy and colors. See the Update resume guide.

call_actions
object

CTA collection — an item with an id patches that CTA, without one creates it, with _destroy: true deletes it. See the Update call actions guide.

smart_autoplay
object

Muted-autoplay overlay — pick a template and a grid position. See the Update smart autoplay guide.

pixels
object

Tracking pixels and when in playback they fire — same id/_destroy collection semantics as CTAs. See the Update pixels guide.

turbo
object

Accelerated playback — the toggle and its rate; experiment leaves are read-only. See the Update turbo guide.

headline
object

The headline variants drawn above the player — same id/_destroy collection semantics as CTAs. Configure at least two, then start the A/B test from the Experiments endpoint.

name
string
description
string
folder_id
string
mini_hooks
object
thumbsniper
object

Response

Send <leaf>_file_id with an uploaded file's id and the video stores that file's public url.

id
string
required
name
string
required
description
string | null
required
folder_id
string | null
required
status
string
required
controls
object
required
call_actions
object
required
alternative_video
object
required
traffic_filter
object
required
styles
object
required
general
object
required
immersive_mode
object
required
mini_hooks
object
required
pixels
object
required
playback
object
required
subtitle
object
required
thumbsniper
object
required
turbo
object
required
headline
object
required
progress_bar
object
required
resume
object
required
smart_autoplay
object
required