Skip to main content
PATCH
/
v1
/
playlists
/
{id}
Update a playlist
curl --request PATCH \
  --url https://api.tella.com/v1/playlists/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Updated description for the playlist",
  "groupId": "pg_abc123def456",
  "linkScope": "public",
  "name": "Updated Playlist Name",
  "password": "newpassword",
  "position": 0,
  "searchEngineIndexingEnabled": true
}
'
import requests

url = "https://api.tella.com/v1/playlists/{id}"

payload = {
"description": "Updated description for the playlist",
"groupId": "pg_abc123def456",
"linkScope": "public",
"name": "Updated Playlist Name",
"password": "newpassword",
"position": 0,
"searchEngineIndexingEnabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'Updated description for the playlist',
groupId: 'pg_abc123def456',
linkScope: 'public',
name: 'Updated Playlist Name',
password: 'newpassword',
position: 0,
searchEngineIndexingEnabled: true
})
};

fetch('https://api.tella.com/v1/playlists/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tella.com/v1/playlists/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => 'Updated description for the playlist',
'groupId' => 'pg_abc123def456',
'linkScope' => 'public',
'name' => 'Updated Playlist Name',
'password' => 'newpassword',
'position' => 0,
'searchEngineIndexingEnabled' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.tella.com/v1/playlists/{id}"

payload := strings.NewReader("{\n \"description\": \"Updated description for the playlist\",\n \"groupId\": \"pg_abc123def456\",\n \"linkScope\": \"public\",\n \"name\": \"Updated Playlist Name\",\n \"password\": \"newpassword\",\n \"position\": 0,\n \"searchEngineIndexingEnabled\": true\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.tella.com/v1/playlists/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Updated description for the playlist\",\n \"groupId\": \"pg_abc123def456\",\n \"linkScope\": \"public\",\n \"name\": \"Updated Playlist Name\",\n \"password\": \"newpassword\",\n \"position\": 0,\n \"searchEngineIndexingEnabled\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.tella.com/v1/playlists/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"Updated description for the playlist\",\n \"groupId\": \"pg_abc123def456\",\n \"linkScope\": \"public\",\n \"name\": \"Updated Playlist Name\",\n \"password\": \"newpassword\",\n \"position\": 0,\n \"searchEngineIndexingEnabled\": true\n}"

response = http.request(request)
puts response.read_body
{
  "playlist": {
    "createdAt": "2024-01-15T10:30:00.000Z",
    "description": "A collection of tutorial videos for our product",
    "emoji": "🎬",
    "groupId": "pg_abc123def456",
    "id": "pl_abc123def456",
    "linkScope": "public",
    "links": {
      "viewPage": "https://www.tella.tv/playlist/pl_abc123def456/view"
    },
    "name": "Product Tutorials",
    "searchEngineIndexingEnabled": true,
    "updatedAt": "2024-01-15T14:45:00.000Z",
    "videos": 12,
    "visibility": "org"
  }
}
{
"error": {
"code": "bad_request",
"doc_url": "https://tella.tv/docs/api-reference/errors#bad-request",
"message": "The request was malformed or contained invalid parameters."
}
}
{
"error": {
"code": "unauthorized",
"doc_url": "https://tella.tv/docs/api-reference/errors#unauthorized",
"message": "Authentication is required. Provide a valid API key."
}
}
{
"error": {
"code": "forbidden",
"doc_url": "https://tella.tv/docs/api-reference/errors#forbidden",
"message": "You don't have permission to access this resource."
}
}
{
"error": {
"code": "not_found",
"doc_url": "https://tella.tv/docs/api-reference/errors#not-found",
"message": "The requested resource was not found."
}
}
{
"error": {
"code": "unprocessable_entity",
"doc_url": "https://tella.tv/docs/api-reference/errors#unprocessable-entity",
"message": "The request was well-formed but contained semantic errors."
}
}
{
"error": {
"code": "rate_limit_exceeded",
"doc_url": "https://tella.tv/docs/api-reference/errors#rate-limit-exceeded",
"message": "You have exceeded the rate limit. Please slow down."
}
}
{
"error": {
"code": "internal_server_error",
"doc_url": "https://tella.tv/docs/api-reference/errors#internal-server-error",
"message": "An unexpected error occurred on the server."
}
}

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