WIwithchima
Playlists

Update a playlist

Changed on

Update a playlist's name and/or description. Changing the playlist's name, description, link access, password, or search engine indexing requires being the playlist's creator or a workspace owner; other editors get 403.

patch/v1/playlists/{id}

Request

Path parameters

idstring required

Unique playlist identifier

Example:pl_abc123def456

Request body

descriptionstring

Playlist description

groupIdstring 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 (only invited users, plus the workspace when visibility is org), password (requires password), embedonly (only viewable when embedded)

namestring

Playlist name

passwordstring

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

positioninteger

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.

searchEngineIndexingEnabledboolean

Allow search engine indexing

Example request

{
  "description": "Updated description for the playlist",
  "groupId": "pg_abc123def456",
  "linkScope": "public",
  "name": "Updated Playlist Name",
  "password": "newpassword",
  "searchEngineIndexingEnabled": true
}

Response

OK

Example response

{
  "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"
  }
}

Changes

  • ac47c99c144fRevision changes
    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

  • 6b1132ef42fbRevision changes
    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new unavailable enum value to the response property for the response status

    • warning

      added the new unavailable enum value to the response property for the response status

    • warning

      added the new unavailable enum value to the response property for the response status

    • warning

      added the new unavailable enum value to the response property for the response status

    • warning

      added the new unavailable enum value to the response property for the response status

    • warning

      added the new unavailable enum value to the response property for the response status

    • warning

      added the new unavailable enum value to the response property for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status