Videos APIGuides

Update playback

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

The playback group governs how the video behaves while it plays — whether the viewer can pause, when the page scrolls to your action, and what happens at the end.

This is a merge-patch: send only the keys you want to change and everything else keeps its stored value.

Loop back to a timestamp when the video ends

curl -X PATCH https://api.vturb.com/v1/videos/{id} \
  -H "Authorization: Bearer vt_..." \
  -H "Content-Type: application/json" \
  -d '{ "playback": { "action_after_finish": { "type": "loop", "start": 42 } } }'

The keys

KeyTypeWrites
enabledbooleanMaster switch for the group
disable_pausebooleanIgnore the viewer's pause clicks
smart_pausebooleanPause automatically when the browser tab is hidden
scroll_to_action_inintegerSecond at which the page scrolls to the action
action_after_finish.typestringWhat to do at the end — loop is the only type today
action_after_finish.startintegerSecond the loop restarts from

action_after_finish is validated as a pair: a loop needs a start, start must be a non-negative number of seconds, and it can't sit beyond the video's duration. Anything else is a 422 unprocessable_content.

On this page