Skip to main content
PATCH
Update a playlist

Authorizations

Authorization
string
header
required

API key obtained from your Tella account settings

Path Parameters

id
string
required

Unique playlist identifier

Example:

"pl_abc123def456"

Body

application/json

Request body for updating a playlist. At least one field must be provided.

description
string

Playlist description

Maximum string length: 5000
Example:

"Updated description for the playlist"

groupId
string | null

Move the playlist into a playlist group (pg_...), or null to remove it from its group. The group's visibility must match the playlist's.

Example:

"pg_abc123def456"

Access level

Available options:
public,
private,
password,
embedonly
Example:

"public"

name
string

Playlist name

Required string length: 1 - 255
Example:

"Updated Playlist Name"

password
string

Password for viewing. Required when linkScope is 'password', ignored otherwise.

Required string length: 1 - 255
Example:

"newpassword"

position
integer

0-based position within the playlist's container (0 = top): its group when grouped, otherwise the sidebar section across groups and ungrouped playlists. Combine with groupId to move into a group at a specific position.

Required range: 0 <= x <= 9007199254740991
Example:

0

searchEngineIndexingEnabled
boolean

Allow search engine indexing

Example:

true

Response

OK

playlist
object
required

Detailed information about a playlist