Update a playlist by ID | FastPix Developer Documentation

curl -X PUT https://api.fastpix.com/v1/on-demand/playlists/playlistId \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "name": "updated name",
  "description": "updated description"
}'

{
  "success": true,
  "data": {
    "id": "e3dfdf15-16bb-4835-98b9-484c1e4320cc",
    "name": "playist",
    "referenceId": "a1",
    "type": "smart",
    "description": "This is a playlist",
    "playOrder": "createdDate ASC",
    "metadata": {
      "createdDate": {
        "startDate": "2024-11-11",
        "endDate": "2024-12-12"
      },
      "updatedDate": {
        "startDate": "2024-11-11",
        "endDate": "2024-12-12"
      }
    },
    "mediaList": [
      {
        "createdAt": "2024-11-12T05:58:38.000708Z",
        "creatorId": "FastPix@14612",
        "duration": "00:00:10",
        "id": "942e0ced-146b-487e-988f-6de578de1000",
        "sourceResolution": "1080p",
        "status": "Ready",
        "thumbnail": "https://venus-images.fastpix.dev/ff31b32e-4979-4d2b-ad2a-685af43c9902/thumbnail.png",
        "title": "Media 1"
      },
      {
        "createdAt": "2024-12-05T07:23:18.000108Z",
        "creatorId": "FastPix@14612",
        "duration": "00:00:10",
        "id": "6d12262b-0686-4131-9de2-bb515f7c0f38",
        "sourceResolution": "1080p",
        "status": "Ready",
        "thumbnail": "https://mercury-images.fastpix.dev/e49a0d7b-6f2c-4743-84d1-45522cc20ded/thumbnail.png",
        "title": "Media 2"
      },
      {
        "createdAt": "2024-12-05T07:21:15.000508Z",
        "creatorId": "FastPix@14612",
        "duration": "00:00:10",
        "id": "a1cd180e-f9b5-4e99-9d44-b9c9baabad89",
        "sourceResolution": "1080p",
        "status": "Ready",
        "thumbnail": "https://mercury-images.fastpix.dev/e49a0d7b-6f2c-4743-84d1-45522cc20ded/thumbnail.png",
        "title": "Media 3"
      }
    ],
    "workspaceId": "d760b903-86ef-44d6-9b73-334130e0cf2d",
    "createdAt": "2025-06-04T13:29:39.409886Z",
    "updatedAt": "2025-06-04T13:29:39.409886Z",
    "mediaCount": 3
  }
}

This endpoint allows you to update the name and description of an existing playlist. It enables modifications to the playlist’s metadata without altering the media items or playlist structure.

How it works

When a user sends a PUT request to this endpoint with the playlistId and updated name and description in the request body, FastPix updates the playlist metadata accordingly and returns the updated playlist details.

Example

An e-learning platform updates the playlist titled “Beginner Python Series” to rename it as “Python Basics” and add a more detailed description. The updated metadata is reflected when retrieving the playlist, helping users better understand the playlist content.

This endpoint allows you to update the name and description of an existing playlist. It enables modifications to the playlist's metadata without altering the media items or playlist structure. #### How it works - When a user sends a PUT request to this endpoint with the `playlistId` and updated name and description in the request body, FastPix updates the playlist metadata accordingly and returns the updated playlist details. #### Example An e-learning platform updates the playlist titled "Beginner Python Series" to rename it as "Python Basics" and add a more detailed description. The updated metadata is reflected when retrieving the playlist, helping users better understand the playlist content.

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

Username: Access Token ID
Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request. - <b>Username:</b> Access Token ID - <b>Password:</b> Secret Key Activate your FastPix account to generate your API credentials. <a href="https://docs.fastpix.io/docs/activate-account" target="_blank">See the guide here</a>

Path parameters

playlistIdstringRequired

The unique id of the playlist you want to retrieve.

Request

This endpoint expects an object.

namestringRequiredDefaults to updated name

New name to the playlist.

descriptionstringRequiredDefaults to updated description

Updated description to the playlist.

Response

Playlist updated successfully

successboolean

Shows the request status. Returns true for success and false for failure.

dataobject

Displays the result of the request.

This endpoint allows you to update the name and description of an existing playlist. It enables modifications to the playlist’s metadata without altering the media items or playlist structure.

How it works

When a user sends a PUT request to this endpoint with the playlistId and updated name and description in the request body, FastPix updates the playlist metadata accordingly and returns the updated playlist details.