Add a bumper to an item

POST

https://api.fastpix.com/v1/cloud-playout/channels/:channelId/programs/:programId/bumper

POST

/v1/cloud-playout/channels/:channelId/programs/:programId/bumper

curl -X POST https://api.fastpix.com/v1/cloud-playout/channels/cc99cae6-56b4-46ab-9f4a-8b2462d8137c/programs/d85083a0-e935-4c29-9c32-6720bdc9b22f/bumper \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "bumperId": "9d9f2c67-0a25-4b3e-9a70-1a5c1d2b6f88",
  "eventId": "4a1e1f3b-2c0d-4c4a-9a02-1d7e5f6b8c90",
  "bumperType": "preroll"
}'

201Created

{
  "success": true,
  "data": {
    "id": "d85083a0-e935-4c29-9c32-6720bdc9b22f",
    "index": 10,
    "name": "Morning block",
    "channelId": "cc99cae6-56b4-46ab-9f4a-8b2462d8137c",
    "mediaCount": 0,
    "duration": "00:00:00",
    "workspaceId": "37d62550-e2a5-4827-b16a-3826e66d77ad",
    "createdAt": "2025-03-12T06:17:26.403017Z",
    "updatedAt": "2025-03-12T06:17:26.403017Z"
  }
}

This endpoint places a bumper immediately before or after an item in a program on a Cloud Playout loop channel, so the channel plays a short clip around that item every time it comes round in the loop.

How it works

Create the bumper first with the create a filler endpoint, using the bumper type.
Make a POST request to this endpoint with the bumperId, the eventId of the item you are placing it against, and whether it is a preroll or a postroll.
The bumper is inserted into the program as an item of its own, directly before the target item for a preroll and directly after it for a postroll.
The response returns the updated program, with the bumper counted in its item count and total duration.

The bumper’s duration is taken from the bumper itself, and the channel’s total program time must still fit inside the channel’s start and end times. On a channel that is on air, a bumper cannot be placed against an item that is already due to play in the next few minutes.

Example

A news channel places a five second sting before its headlines block, so the sting introduces the block on every pass of the loop.

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 bumper is added to.

Request

This endpoint expects an object.

bumperIdstringRequiredformat: "uuid"

The unique identifier of the bumper to place, as returned by the create a filler endpoint. It must belong to the same workspace as the channel.

eventIdstringRequiredformat: "uuid"

The unique identifier of the item the bumper is placed against, as returned in the id field by the get items in a program endpoint.

bumperTypeenumRequired

Where the bumper is placed. preroll plays it immediately before the item, and postroll immediately after it.

Allowed values:

Response

Bumper added to the item successfully

successbooleanOptional

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

dataobjectOptional

A program on a Cloud Playout loop channel.