Skip to navigation
CLOUD PLAYOUT APILoop programs

Add a playlist to a program

This endpoint adds every media item in a FastPix playlist to a program on a Cloud Playout loop channel, in one request. It is a faster way to fill a program than adding media items one at a time, and it keeps the playlist’s order.

How it works

  1. Make a POST request to this endpoint with the playlistId of the playlist you want to add.

  2. The media items in the playlist are appended to the end of the program, in the order they appear in the playlist.

  3. The response returns the updated program, with the added items counted in its item count and total duration.

Every media item in the playlist must have a public access policy, and the playlist must contain at least one item. The playlist itself is not linked to the program; its items are copied in as they are at the time of the request, so later changes to the playlist do not change the program.

Example

A music channel keeps a curated playlist of new releases in its media library, and adds it to the channel’s evening program each week in a single request.

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

Path parameters

channelIdstringRequiredformat: "uuid"
The unique identifier of the loop channel the program belongs to.
programIdstringRequiredformat: "uuid"
The unique identifier of the program the playlist is added to.

Request

This endpoint expects an object.
playlistIdstringRequiredformat: "uuid"
The unique identifier of the playlist whose media items are added to the program. The playlist must contain at least one media item, and every item in it must have a public access policy.

Response

Playlist added to the program successfully
successbooleanOptional
Shows the request status. Returns true for success and false for failure.
dataobjectOptional
A program on a Cloud Playout loop channel.