Skip to main content
POST
Deploy settings

Authorizations

Authorization
string
header
required

A scoped token minted in Settings → API tokens. Send it as Authorization: Bearer tplt_… or X-API-Key: tplt_….

Headers

Idempotency-Key
string

Retry-safe key. The first response for a given key is cached for 24 hours and replayed on a repeat, with Idempotency-Replayed: true set.

Path Parameters

video
integer
required

The video's numeric ID.

Body

application/json

A partial or full settings payload, keyed by option-group column name, for example style_options, playback_options, autoplay_options, progress_options, actions_options, pixels_options, continue_watching_options, turbo_options, timed_events_options, captions_options, chapters_options, cta_cards_options, playlist_options, engagement_options, lead_form_options, watch_gate_options, cross_device_resume_options, notes_options, or quiz_options. Send only the groups you want to change. Each group has its own validation rules, the same ones the dashboard's Customize screen enforces, so a malformed value inside any group fails the whole request with a 422.

Response

Deployed.

video
object

A video and its settings. A video carries around thirty option-group columns (style, playback, autoplay, captions, chapters, CTA cards, playlist, and more) that are not itemized here. Read GET /videos/{video}/settings for the full set, or the dedicated endpoint for the group you care about (captions, chapters, AI segments, CTA cards).

version_id
integer | null

The ID of the version snapshot this deploy created. Pass it to GET /videos/{video}/deploys or restore it later.

embed_url
string | null

The video's embed page URL.