Skip to main content
POST
Enable a playlist on a video

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.

Body

application/json
video_id
integer
required

The video that becomes the playlist's primary video. Required. Playlists have no resource of their own: enabling one turns this video into the playlist's anchor.

playback_mode
enum<string>

Defaults to linear.

Available options:
linear,
course
playlist_code
string
Maximum string length: 128
items
object[]

Seed the playlist with items in one call, instead of adding them one at a time with POST /playlists/{playlist}/videos.

auto_advance
boolean

Defaults to true.

loop
boolean

Defaults to false.

playlist_chrome
enum<string>
Available options:
rail,
button

Response

The playlist.

playlist
object