Skip to navigation
CLOUD PLAYOUT APISchedule channel

Update an event on a schedule channel

This endpoint moves or renames an event on a Cloud Playout schedule channel, and is also how you attach a bumper to it. The id in the path is the event’s ID, not the channel’s.

How it works

  1. Make a PATCH request to this endpoint with the ID of the event you want to change.

  2. Send both startTime and endTime. Both are required, even if only one of them changes.

  3. Optionally send a name, and a bumper with a preroll, a postroll, or both. Each bumper needs its id and its duration, and the duration must match the bumper’s own length.

  4. The response returns the updated event.

The type of an event cannot be changed, and neither can what it plays, so leave type out and either leave referenceId out or send the one the event already has. A live event must still be at least 5 minutes long. Sending a bumper with no preroll and no postroll clears the ones already attached, and bumpers cannot be attached to an event that has segments on it. On a channel that is on air, an event cannot be changed if it runs, or would run, in the next few minutes.

Example

A broadcaster pushes an evening film back by fifteen minutes and adds a five second sting in front of it.

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

idstringRequiredformat: "uuid"

The unique identifier of the event to update, as returned in the id field by the get the events on a schedule channel endpoint.

Request

This endpoint expects an object.
eventobjectRequired

Response

Schedule channel event updated successfully
successbooleanOptional
Shows the request status. Returns true for success and false for failure.
dataobjectOptional
An event on a Cloud Playout schedule channel.