---
title: "Update a playlist"
method: PATCH
path: "/v1/playlists/{id}"
tags: ["Playlists"]
---

# Update a playlist

`PATCH /v1/playlists/{id}`

Update a playlist's name and/or description

## Path parameters

- `id` string, required — Unique playlist identifier

## Request body

- UpdatePlaylistRequest — Request body for updating a playlist. At least one field must be provided.
  - `description` string — Playlist description
  - `groupId` string, nullable — 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.
  - `linkScope` 'public' | 'private' | 'password' | 'embedonly' — Access level: public (anyone with link), private (org members only), password (requires password), embedonly (only viewable when embedded)
  - `name` string — Playlist name
  - `password` string — Password for viewing. Required when linkScope is 'password', ignored otherwise.
  - `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.
  - `searchEngineIndexingEnabled` boolean — Allow search engine indexing

## Response `200`

OK

- object
  - `playlist` PlaylistDetail, required — Detailed information about a playlist
    - `createdAt` string, date-time, required — ISO 8601 datetime
    - `description` string, required — Playlist description
    - `emoji` string, required — Unicode emoji character for the playlist
    - `groupId` string, nullable, required — Playlist group this playlist belongs to in the sidebar, or null if ungrouped
    - `id` string, required — Unique playlist identifier
    - `linkScope` 'public' | 'private' | 'password' | 'embedonly', required — Access level: public (anyone with link), private (org members only), password (requires password), embedonly (only viewable when embedded)
    - `links` PlaylistLinks, required — URLs related to a playlist
      - `viewPage` string, uri, required — URL to view the playlist on Tella
    - `name` string, required — Playlist name
    - `searchEngineIndexingEnabled` boolean, required — Whether search engines can index this playlist
    - `updatedAt` string, date-time, required — ISO 8601 datetime
    - `videos` integer, required — Number of videos in the playlist
    - `visibility` 'org' | 'personal', required — Visibility: org (shared with entire organization) or personal (only creator)

## Other responses

- `400` — The request was malformed or contained invalid parameters.
- `401` — Authentication is required. Provide a valid API key.
- `403` — You don't have permission to access this resource.
- `404` — The requested resource was not found.
- `429` — You have exceeded the rate limit. Please slow down.
- `500` — An unexpected error occurred
- `501` — The requested operation is not implemented.

---

[API](https://skmtc.dev/withchima/apis/tella-public-api.md) · [All operations](https://skmtc.dev/withchima/apis/tella-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/withchima/tella-public-api/revisions/ba2bb13928a5/schema)