Skip to main content
PATCH
Update a playlist's 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

playlist
integer
required

The numeric ID of the video the playlist lives on. A playlist has no ID of its own: it is settings stored on a video row, so this is that video's id, the same value you would pass to GET /videos/{video}.

Body

application/json

Every field is optional. Send only what you want to change.

playback_mode
enum<string>
Available options:
linear,
course
playlist_code
string
Maximum string length: 128
auto_advance
boolean
auto_advance_delay_ms
integer
Required range: 0 <= x <= 30000
loop
boolean
lesson_navigation
enum<string>
Available options:
sidebar,
next-button,
both,
none
playlist_chrome
enum<string>
Available options:
rail,
button

Response

The updated playlist.

playlist
object