Skip to navigation
CLOUD PLAYOUT APILoop programs

Remove several items from a program

This endpoint removes up to 500 items from a program on a Cloud Playout loop channel in one request. Use it to clear out a block of content without making a request per item.

How it works

  1. Make a POST request to this endpoint with the IDs of the items you want to remove, which you can get from the get items in a program endpoint.

  2. The request is all or nothing. If any id does not belong to the program, or any of the items cannot be removed right now, nothing is removed and the response tells you which ids were the problem.

  3. Any segments marked on the removed items go with them, and the clips FastPix created for those segments are deleted from your media library. The media the items played is not affected.

Repeating the same id in the list has no extra effect. On a channel that is on air, an item cannot be removed if it is already due to play in the next few minutes, and the channel must be left with at least one item to play.

Example

A broadcaster clears an entire promotional block from the morning program in one request at the end of a campaign.

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 items are removed from.

Request

This endpoint expects an object.
eventIdslist of stringsRequired

The unique identifiers of the items to remove, as returned in the id field by the get items in a program endpoint. Every id must belong to the program in the path.

Response

Items removed from the program successfully
successbooleanOptional
Shows the request status. Returns true for success and false for failure.